blob: 6605b606554e8fd48c38b1d251dca1a26e02f9b7 [file] [log] [blame]
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07001/* Copyright (c) 2015-2017 The Khronos Group Inc.
2 * Copyright (c) 2015-2017 Valve Corporation
3 * Copyright (c) 2015-2017 LunarG, Inc.
4 * Copyright (C) 2015-2017 Google Inc.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070020 */
21
22// Allow use of STL min and max functions in Windows
23#define NOMINMAX
24
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
29#include "vk_layer_data.h"
30#include "vk_layer_utils.h"
31#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060032#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033
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),
Mark Lobodzinski88529492018-04-01 10:38:15 -060098 DRAWSTATE_INVALID_LAYOUT,
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),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600105 DRAWSTATE_INVALID_LAYOUT,
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),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600129 DRAWSTATE_INVALID_LAYOUT,
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,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600316 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_RENDERPASS,
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,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600339 DRAWSTATE_INVALID_RENDERPASS,
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) {
Cort Strattond46dcb52018-04-10 14:52:49 -0700391 skip =
392 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
393 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer), VALIDATION_ERROR_0a00095a,
394 "For image 0x%" PRIx64
395 " you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
396 HandleToUint64(mem_barrier->image), aspect, level, layer, string_VkImageLayout(mem_barrier->oldLayout),
397 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700398 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700399 return skip;
400}
401
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700402// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
403// 1. Transition into initialLayout state
404// 2. Transition from initialLayout to layout used in subpass 0
405void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
406 FRAMEBUFFER_STATE *framebuffer_state) {
407 // First transition into initialLayout
408 auto const rpci = render_pass_state->createInfo.ptr();
409 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
410 VkImageView image_view = framebuffer_state->createInfo.pAttachments[i];
411 SetImageViewLayout(device_data, cb_state, image_view, rpci->pAttachments[i].initialLayout);
412 }
413 // Now transition for first subpass (index 0)
414 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
415}
416
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700417void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
418 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
419 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
420 return;
421 }
422 VkImageSubresource sub = {aspect, level, layer};
423 IMAGE_CMD_BUF_LAYOUT_NODE node;
424 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700425 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700426 SetLayout(device_data, pCB, mem_barrier->image, sub,
427 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
428 return;
429 }
430 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
431 // TODO: Set memory invalid
432 }
433 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
434}
435
Dave Houlton10b39482017-03-16 13:18:15 -0600436bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600437 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600438 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600439 }
440 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600441 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600442 }
443 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600444 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600445 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700446 if (0 !=
447 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
448 if (FormatPlaneCount(format) == 1) return false;
449 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600450 return true;
451}
452
Mike Weiblen62d08a32017-03-07 22:18:27 -0700453// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
454bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
455 VkImageUsageFlags usage_flags, const char *func_name) {
456 const auto report_data = core_validation::GetReportData(device_data);
457 bool skip = false;
458 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
459 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
460
461 switch (layout) {
462 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
463 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600464 msg_code = VALIDATION_ERROR_0a000970;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700465 }
466 break;
467 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
468 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600469 msg_code = VALIDATION_ERROR_0a000972;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700470 }
471 break;
472 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
473 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600474 msg_code = VALIDATION_ERROR_0a000974;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700475 }
476 break;
477 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
478 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600479 msg_code = VALIDATION_ERROR_0a000976;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700480 }
481 break;
482 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
483 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600484 msg_code = VALIDATION_ERROR_0a000978;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700485 }
486 break;
487 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
488 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600489 msg_code = VALIDATION_ERROR_0a00097a;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700490 }
491 break;
492 default:
493 // Other VkImageLayout values do not have VUs defined in this context.
494 break;
495 }
496
497 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600498 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600499 HandleToUint64(img_barrier->image), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600500 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ".",
501 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
502 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags);
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,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600527 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, 0,
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)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -0600541 skip |=
542 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
543 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), VALIDATION_ERROR_0a00096e,
544 "%s: Image barrier 0x%p references image 0x%" PRIx64
545 " of format %s that must have the depth and stencil aspects set, but its aspectMask is 0x%" PRIx32 ".",
546 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
547 string_VkFormat(image_create_info->format), aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600548 }
549 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600550 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
551 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700552
Mike Weiblen62d08a32017-03-07 22:18:27 -0700553 for (uint32_t j = 0; j < level_count; j++) {
554 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
555 for (uint32_t k = 0; k < layer_count; k++) {
556 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600557 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
558 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
559 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
560 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700561 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
562 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
563 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
564 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
565 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
566 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
567 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
568 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569 }
570 }
571 }
572 return skip;
573}
574
Chris Forbes4de4b132017-08-21 11:27:08 -0700575static bool IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600576 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700577
578 auto pool = GetCommandPoolNode(device_data, cb_state->createInfo.commandPool);
John Zulauf1b33d5a2018-03-24 19:52:19 -0600579 return pool && IsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700580}
581
Chris Forbes399a6782017-08-18 15:00:48 -0700582void TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700583 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700584 for (uint32_t i = 0; i < memBarrierCount; ++i) {
585 auto mem_barrier = &pImgMemBarriers[i];
586 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700587
Chris Forbes4de4b132017-08-21 11:27:08 -0700588 // For ownership transfers, the barrier is specified twice; as a release
589 // operation on the yielding queue family, and as an acquire operation
590 // on the acquiring queue family. This barrier may also include a layout
591 // transition, which occurs 'between' the two operations. For validation
592 // purposes it doesn't seem important which side performs the layout
593 // transition, but it must not be performed twice. We'll arbitrarily
594 // choose to perform it as part of the acquire operation.
595 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
596 continue;
597 }
598
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600599 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
600 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
601 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
602
Dave Houltonb3f4b282018-02-22 16:25:16 -0700603 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
604 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
605 // for all (potential) layer sub_resources.
606 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
607 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
608 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
609 }
610
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600611 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700612 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600613 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700614 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Chris Forbes399a6782017-08-18 15:00:48 -0700615 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
616 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
617 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
618 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700619 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
Chris Forbes399a6782017-08-18 15:00:48 -0700620 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
621 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
622 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700623 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700624 }
625 }
626 }
627}
628
Tobin Ehlisc8266452017-04-07 12:20:30 -0600629bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600630 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600631 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700632 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600633 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600634 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700635
636 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
637 uint32_t layer = i + subLayers.baseArrayLayer;
638 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
639 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600640 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
641 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600642 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600643 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100644 skip |= log_msg(
645 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600646 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Petr Kraus13c98a62017-12-09 00:22:39 +0100647 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
648 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600649 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700650 }
651 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600652 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
653 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
654 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700655 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
656 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600657 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600658 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -0600659 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Petr Kraus13c98a62017-12-09 00:22:39 +0100660 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
661 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700662 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600663 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600664 if (image_state->shared_presentable) {
665 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
666 // TODO: Add unique error id when available.
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600667 skip |=
668 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, msg_code,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600669 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600670 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600671 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600672 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700673 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600674 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600675 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600676 HandleToUint64(cb_node->commandBuffer), msg_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600677 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
678 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700679 }
680 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600681 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700682}
683
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700684void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
685 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700686 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700687 if (!renderPass) return;
688
689 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
690 if (framebuffer_state) {
691 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
692 auto image_view = framebuffer_state->createInfo.pAttachments[i];
693 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
694 }
695 }
696}
Dave Houltone19e20d2018-02-02 16:32:41 -0700697
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700698bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700699 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600700 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700701 const debug_report_data *report_data = core_validation::GetReportData(device_data);
702
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600703 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600704 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600705 VALIDATION_ERROR_09e0075e, "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600706
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600707 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600708 }
709
Dave Houlton130c0212018-01-29 13:39:56 -0700710 const char *format_string = string_VkFormat(pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700711
712 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
713 std::stringstream ss;
714 ss << "vkCreateImage: Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600715 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600716 VALIDATION_ERROR_09e0076a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700717 }
718
719 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
720 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
721 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
722 if (VK_SUCCESS != err) {
723 std::stringstream ss;
724 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
725 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600726 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600727 VALIDATION_ERROR_09e00758, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700728 return skip;
729 }
730
731 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
732 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
733 std::stringstream ss;
734 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600735 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600736 VALIDATION_ERROR_09e0076e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700737 }
738
739 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
740 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
741 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
742 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600743 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700744 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600745 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600746 VALIDATION_ERROR_09e00770, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600747 }
Dave Houlton130c0212018-01-29 13:39:56 -0700748 } else {
749 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
750 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600751 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700752 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
753 "format "
754 << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600755 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600756 VALIDATION_ERROR_09e00772, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600757 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600758 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700759 }
760
Dave Houlton130c0212018-01-29 13:39:56 -0700761 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
762 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
763 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
764 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
765 std::stringstream ss;
766 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600767 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600768 VALIDATION_ERROR_09e00776, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700769 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700770 }
771
Dave Houlton130c0212018-01-29 13:39:56 -0700772 // 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 -0700773 // 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 -0700774 // implementation shown. DJH
775 //
776 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
777 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
778 // device_limits->maxImageDimension3D)) {
779 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
780 std::stringstream ss;
781 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600782 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600783 VALIDATION_ERROR_09e0077e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700784 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700785
Dave Houlton130c0212018-01-29 13:39:56 -0700786 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
787 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
788 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
789 std::stringstream ss;
790 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
791 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600793 VALIDATION_ERROR_09e00788, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700794 }
795
796 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
797 std::stringstream ss;
798 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
799 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600801 VALIDATION_ERROR_09e0078a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700802 }
803
804 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
805 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
806 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
807
808 // Round up to imageGranularity boundary
809 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
810 uint64_t ig_mask = imageGranularity - 1;
811 total_size = (total_size + ig_mask) & ~ig_mask;
812
813 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600814 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600815 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700816 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
817 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700818 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700819 }
820
Dave Houlton130c0212018-01-29 13:39:56 -0700821 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600822 skip |=
823 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, VALIDATION_ERROR_09e00780,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600824 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
825 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700826 }
827
Dave Houlton130c0212018-01-29 13:39:56 -0700828 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600829 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600830 VALIDATION_ERROR_09e0078e, "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600831 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700832 }
833
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600834 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600835 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600836 DRAWSTATE_INVALID_FEATURE,
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600837 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
838 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600839 }
840
Lenny Komowb79f04a2017-09-18 17:07:00 -0600841 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
842 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
843 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
844 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
845 // TODO: Add Maintenance2 VUID
846 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600847 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600848 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600849 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
850 "format must be block, ETC or ASTC compressed, but is %s",
851 string_VkFormat(pCreateInfo->format));
852 }
853 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
854 // TODO: Add Maintenance2 VUID
855 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600856 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600857 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600858 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
859 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
860 }
861 }
862 }
863
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600864 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700865}
866
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700867void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700868 IMAGE_LAYOUT_NODE image_state;
869 image_state.layout = pCreateInfo->initialLayout;
870 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700871 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 -0700872 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700873 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
874 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700875}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700876
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700877bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700878 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700879 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200880 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700881 if (disabled->destroy_image) return false;
882 bool skip = false;
883 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600884 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
885 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700886 }
887 return skip;
888}
889
John Zulauffca05c12018-04-26 16:30:39 -0600890void PreCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700891 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
892 // Clean up memory mapping, bindings and range references for image
893 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700894 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700895 if (mem_info) {
896 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
897 }
898 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600899 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700900 // Remove image from imageMap
901 core_validation::GetImageMap(device_data)->erase(image);
902 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
903 core_validation::GetImageSubresourceMap(device_data);
904
905 const auto &sub_entry = imageSubresourceMap->find(image);
906 if (sub_entry != imageSubresourceMap->end()) {
907 for (const auto &pair : sub_entry->second) {
908 core_validation::GetImageLayoutMap(device_data)->erase(pair);
909 }
910 imageSubresourceMap->erase(sub_entry);
911 }
912}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700913
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700914bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700915 bool skip = false;
916 const debug_report_data *report_data = core_validation::GetReportData(device_data);
917
918 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
919 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
920 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600921 HandleToUint64(image_state->image), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700922 }
923
Dave Houlton1d2022c2017-03-29 11:43:58 -0600924 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700925 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
926 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600927 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600928 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700929 char const str[] = "vkCmdClearColorImage called with compressed image.";
930 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600931 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700932 }
933
934 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
935 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
936 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600937 HandleToUint64(image_state->image), VALIDATION_ERROR_18800004, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700938 }
939 return skip;
940}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700941
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600942uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
943 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
944 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700945 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600946 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700947 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600948 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700949}
950
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600951uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
952 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
953 uint32_t array_layer_count = range->layerCount;
954 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
955 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700956 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600957 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700958}
959
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700960bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700961 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
962 bool skip = false;
963 const debug_report_data *report_data = core_validation::GetReportData(device_data);
964
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600965 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
966 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700967
968 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
969 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700970 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
971 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600972 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600973 HandleToUint64(image_state->image), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700974 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
975 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600976 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600977 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600978 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600979 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600980 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -0600981 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
982 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600983
984 } else {
985 if (image_state->shared_presentable) {
986 skip |= log_msg(
987 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -0600988 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600989 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
990 string_VkImageLayout(dest_image_layout));
991 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600992 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700993 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600994 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700995 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600996 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700997 } else {
998 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
999 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001001 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001002 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1003 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001004 }
1005 }
1006
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001007 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1008 uint32_t level = level_index + range.baseMipLevel;
1009 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1010 uint32_t layer = layer_index + range.baseArrayLayer;
1011 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001012 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001013 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001014 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001015 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001016 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001017 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001018 } else {
1019 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1020 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001021 skip |=
1022 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1023 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1024 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001025 }
1026 }
1027 }
1028 }
1029
1030 return skip;
1031}
1032
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001033void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1034 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001035 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1036 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1037 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001038
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001039 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1040 uint32_t level = level_index + range.baseMipLevel;
1041 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1042 uint32_t layer = layer_index + range.baseArrayLayer;
1043 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001044 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001045 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1046 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 -07001047 }
1048 }
1049 }
1050}
1051
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001052bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001053 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1054 bool skip = false;
1055 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001056 auto cb_node = GetCBNode(dev_data, commandBuffer);
1057 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001058 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001059 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001060 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001061 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001062 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001063 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001064 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001065 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001066 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001067 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001068 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001069 }
1070 }
1071 return skip;
1072}
1073
1074// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001075void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001076 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001077 auto cb_node = GetCBNode(dev_data, commandBuffer);
1078 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001079 if (cb_node && image_state) {
1080 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001081 for (uint32_t i = 0; i < rangeCount; ++i) {
1082 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1083 }
1084 }
1085}
1086
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001087bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1088 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001089 const VkImageSubresourceRange *pRanges) {
1090 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001091 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1092
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001093 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001094 auto cb_node = GetCBNode(device_data, commandBuffer);
1095 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001096 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001097 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001098 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001099 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001100 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001101 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001102 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001103 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001104 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001105 skip |=
1106 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001107 // Image aspect must be depth or stencil or both
1108 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1109 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1110 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001111 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1112 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001113 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001114 HandleToUint64(commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001115 }
1116 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001117 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001118 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001119 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001120 HandleToUint64(image), VALIDATION_ERROR_18a0001c, "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001121 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001122 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1123 char const str[] =
1124 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1125 "set.";
1126 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001127 HandleToUint64(image), VALIDATION_ERROR_18a00012, "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001128 }
1129 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1130 VkImageTiling tiling = image_state->createInfo.tiling;
1131 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1132 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1133 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001134 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001135 HandleToUint64(image), VALIDATION_ERROR_18a00010,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001136 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1137 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR.",
1138 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling));
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001139 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001140 }
1141 return skip;
1142}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001143
1144// Returns true if [x, xoffset] and [y, yoffset] overlap
1145static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1146 bool result = false;
1147 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1148 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1149
1150 if (intersection_max > intersection_min) {
1151 result = true;
1152 }
1153 return result;
1154}
1155
Dave Houltonc991cc92018-03-06 11:08:51 -07001156// Returns true if source area of first copy region intersects dest area of second region
1157// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1158static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001159 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001160
Dave Houltonc991cc92018-03-06 11:08:51 -07001161 // Separate planes within a multiplane image cannot intersect
1162 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001163 return result;
1164 }
1165
Dave Houltonc991cc92018-03-06 11:08:51 -07001166 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1167 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1168 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001169 result = true;
1170 switch (type) {
1171 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001172 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001173 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001174 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001175 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001176 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001177 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001178 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001179 break;
1180 default:
1181 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1182 assert(false);
1183 }
1184 }
1185 return result;
1186}
1187
Dave Houltonfc1a4052017-04-27 14:32:45 -06001188// Returns non-zero if offset and extent exceed image extents
1189static const uint32_t x_bit = 1;
1190static const uint32_t y_bit = 2;
1191static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001192static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001193 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001194 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001195 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1196 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001197 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001198 }
1199 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1200 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001201 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001202 }
1203 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1204 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001205 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001206 }
1207 return result;
1208}
1209
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001210// Test if two VkExtent3D structs are equivalent
1211static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1212 bool result = true;
1213 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1214 (extent->depth != other_extent->depth)) {
1215 result = false;
1216 }
1217 return result;
1218}
1219
Dave Houltonee281a52017-12-08 13:51:02 -07001220// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1221// Destination image texel extents must be adjusted by block size for the dest validation checks
1222VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1223 VkExtent3D adjusted_extent = extent;
1224 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1225 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1226 adjusted_extent.width /= block_size.width;
1227 adjusted_extent.height /= block_size.height;
1228 adjusted_extent.depth /= block_size.depth;
1229 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1230 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1231 adjusted_extent.width *= block_size.width;
1232 adjusted_extent.height *= block_size.height;
1233 adjusted_extent.depth *= block_size.depth;
1234 }
1235 return adjusted_extent;
1236}
1237
Dave Houlton6f9059e2017-05-02 17:15:13 -06001238// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001239static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1240 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001241
1242 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001243 if (mip >= img->createInfo.mipLevels) {
1244 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001245 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001246
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001247 // 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 -06001248 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001249 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1250 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1251 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001252
Dave Houlton6f9059e2017-05-02 17:15:13 -06001253 // Image arrays have an effective z extent that isn't diminished by mip level
1254 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001255 extent.depth = img->createInfo.arrayLayers;
1256 }
1257
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001258 return extent;
1259}
1260
1261// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001262static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001263 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1264}
1265
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001266// Test if the extent argument has any dimensions set to 0.
1267static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1268 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1269}
1270
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001271// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1272static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1273 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1274 VkExtent3D granularity = {0, 0, 0};
1275 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1276 if (pPool) {
1277 granularity =
1278 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001279 if (FormatIsCompressed(img->createInfo.format)) {
1280 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001281 granularity.width *= block_size.width;
1282 granularity.height *= block_size.height;
1283 }
1284 }
1285 return granularity;
1286}
1287
1288// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1289static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1290 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001291 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1292 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001293 valid = false;
1294 }
1295 return valid;
1296}
1297
1298// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1299static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
Cort Stratton420ebd42018-05-04 01:12:23 -04001300 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
1301 UNIQUE_VALIDATION_ERROR_CODE vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001302 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1303 bool skip = false;
1304 VkExtent3D offset_extent = {};
1305 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1306 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1307 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001308 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001309 // 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 -07001310 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001311 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04001312 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001313 "%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 "
1314 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001315 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001316 }
1317 } else {
1318 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1319 // integer multiples of the image transfer granularity.
1320 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001321 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04001322 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001323 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1324 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001325 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1326 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001327 }
1328 }
1329 return skip;
1330}
1331
1332// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1333static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1334 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001335 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
1336 UNIQUE_VALIDATION_ERROR_CODE vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001337 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1338 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001339 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001340 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1341 // subresource extent.
1342 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04001344 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001345 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1346 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1347 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1348 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001349 }
1350 } else {
1351 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1352 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1353 // subresource extent dimensions.
1354 VkExtent3D offset_extent_sum = {};
1355 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1356 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1357 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001358 bool x_ok = true;
1359 bool y_ok = true;
1360 bool z_ok = true;
1361 switch (image_type) {
1362 case VK_IMAGE_TYPE_3D:
1363 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1364 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001365 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001366 case VK_IMAGE_TYPE_2D:
1367 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1368 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001369 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001370 case VK_IMAGE_TYPE_1D:
1371 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1372 (subresource_extent->width == offset_extent_sum.width));
1373 break;
1374 default:
1375 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1376 assert(false);
1377 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001378 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001379 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04001380 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001381 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1382 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1383 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1384 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1385 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1386 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001387 }
1388 }
1389 return skip;
1390}
1391
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001392// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001393bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1394 const IMAGE_STATE *img, const VkBufferImageCopy *region,
Cort Stratton420ebd42018-05-04 01:12:23 -04001395 const uint32_t i, const char *function,
1396 UNIQUE_VALIDATION_ERROR_CODE vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001397 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04001398 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1399 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
1400 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1401 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1402 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001403 return skip;
1404}
1405
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001406// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001407bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001408 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1409 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001410 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001411 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001412 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Cort Stratton420ebd42018-05-04 01:12:23 -04001413 skip |=
1414 CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", VALIDATION_ERROR_19000dee);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001415 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001416 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001417 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001418 src_img->createInfo.imageType, i, function, "extent", VALIDATION_ERROR_19000dee);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001419
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001420 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001421 granularity = GetScaledItg(device_data, cb_node, dst_img);
Cort Stratton420ebd42018-05-04 01:12:23 -04001422 skip |=
1423 CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", VALIDATION_ERROR_19000df0);
Dave Houltonee281a52017-12-08 13:51:02 -07001424 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001425 const VkExtent3D dest_effective_extent =
1426 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001427 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001428 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04001429 dst_img->createInfo.imageType, i, function, "extent", VALIDATION_ERROR_19000df0);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001430 return skip;
1431}
1432
Dave Houlton6f9059e2017-05-02 17:15:13 -06001433// Validate contents of a VkImageCopy struct
1434bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1435 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1436 bool skip = false;
1437
1438 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001439 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001440
1441 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001442 const VkExtent3D src_copy_extent = region.extent;
1443 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001444 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1445
Dave Houlton6f9059e2017-05-02 17:15:13 -06001446 bool slice_override = false;
1447 uint32_t depth_slices = 0;
1448
1449 // Special case for copying between a 1D/2D array and a 3D image
1450 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1451 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001452 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001453 slice_override = (depth_slices != 1);
1454 } 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 -07001455 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001456 slice_override = (depth_slices != 1);
1457 }
1458
1459 // Do all checks on source image
1460 //
1461 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001462 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1463 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001464 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00124,
Dave Houltonee281a52017-12-08 13:51:02 -07001465 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001466 "be 0 and 1, respectively.",
1467 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001468 }
1469 }
1470
Dave Houlton533be9f2018-03-26 17:08:30 -06001471 // VUID-VkImageCopy-srcImage-01785
1472 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1473 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001474 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df2,
Dave Houlton533be9f2018-03-26 17:08:30 -06001475 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001476 "these must be 0 and 1, respectively.",
1477 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001478 }
1479
Dave Houlton533be9f2018-03-26 17:08:30 -06001480 // VUID-VkImageCopy-srcImage-01787
1481 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1482 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001483 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001484 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1485 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001486 }
1487
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001488 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001489 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001490 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001491 skip |=
1492 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001493 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001494 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001495 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1496 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001497 }
1498 }
1499 } else { // Pre maint 1
1500 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001501 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001502 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001503 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001504 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1505 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001506 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1507 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001508 }
1509 }
1510 }
1511
Dave Houltonc991cc92018-03-06 11:08:51 -07001512 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1513 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
1514 if (FormatIsCompressed(src_state->createInfo.format) ||
1515 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001516 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001517 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001518 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1519 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1520 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001521 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d7e : VALIDATION_ERROR_09c0013a;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001522 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001523 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001524 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001525 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001526 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001527 }
1528
Dave Houlton94a00372017-12-14 15:08:47 -07001529 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001530 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1531 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001532 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d80 : VALIDATION_ERROR_09c0013c;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001533 skip |=
1534 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001535 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001536 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001537 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001538 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001539 }
1540
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001541 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001542 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1543 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001544 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d82 : VALIDATION_ERROR_09c0013e;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001545 skip |=
1546 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001547 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001548 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001549 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001550 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001551 }
1552
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001553 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001554 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1555 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001556 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d84 : VALIDATION_ERROR_09c00140;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001557 skip |=
1558 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001559 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001560 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001561 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001562 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001563 }
1564 } // Compressed
1565
1566 // Do all checks on dest image
1567 //
1568 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001569 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001570 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001571 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00130,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001572 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001573 "these must be 0 and 1, respectively.",
1574 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001575 }
1576 }
1577
Dave Houlton533be9f2018-03-26 17:08:30 -06001578 // VUID-VkImageCopy-dstImage-01786
1579 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1580 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001581 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df4,
Dave Houlton533be9f2018-03-26 17:08:30 -06001582 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001583 "and 1, respectively.",
1584 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06001585 }
1586
1587 // VUID-VkImageCopy-dstImage-01788
1588 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1589 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001590 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001591 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
1592 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001593 }
1594
1595 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001596 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001597 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001598 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001599 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001600 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1601 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001602 }
1603 }
1604 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001605 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001606 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001607 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001608 skip |=
1609 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001610 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001611 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001612 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1613 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001614 }
1615 }
1616 } else { // Pre maint 1
1617 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001618 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001619 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001620 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001621 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1622 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001623 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1624 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001625 }
1626 }
1627 }
1628
Dave Houltonc991cc92018-03-06 11:08:51 -07001629 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1630 if (FormatIsCompressed(dst_state->createInfo.format) ||
1631 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001632 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001633
1634 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001635 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1636 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1637 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001638 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d86 : VALIDATION_ERROR_09c00144;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001639 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001640 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001641 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001642 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001643 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001644 }
1645
Dave Houlton94a00372017-12-14 15:08:47 -07001646 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001647 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1648 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001649 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d88 : VALIDATION_ERROR_09c00146;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001650 skip |=
1651 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001652 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001653 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001654 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001655 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001656 }
1657
Dave Houltonee281a52017-12-08 13:51:02 -07001658 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1659 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1660 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001661 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8a : VALIDATION_ERROR_09c00148;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001662 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001663 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001664 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1665 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07001666 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001667 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001668 }
1669
Dave Houltonee281a52017-12-08 13:51:02 -07001670 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1671 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1672 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001673 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8c : VALIDATION_ERROR_09c0014a;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001674 skip |=
1675 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001676 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001677 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001678 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001679 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001680 }
1681 } // Compressed
1682 }
1683 return skip;
1684}
1685
Dave Houltonc991cc92018-03-06 11:08:51 -07001686// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
1687bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
1688 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
1689 bool skip = false;
1690 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
1691
1692 // Neither image is multiplane
1693 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
1694 // If neither image is multi-plane the aspectMask member of src and dst must match
1695 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1696 std::stringstream ss;
1697 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
1698 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
1699 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1700 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c1e, "%s.", ss.str().c_str());
1701 }
1702 } else {
1703 // Source image multiplane checks
1704 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
1705 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
1706 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1707 std::stringstream ss;
1708 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1709 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1710 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c20, "%s.", ss.str().c_str());
1711 }
1712 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1713 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1714 std::stringstream ss;
1715 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1717 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c22, "%s.", ss.str().c_str());
1718 }
1719 // Single-plane to multi-plane
1720 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1721 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1722 std::stringstream ss;
1723 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1724 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1725 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c2a, "%s.", ss.str().c_str());
1726 }
1727
1728 // Dest image multiplane checks
1729 planes = FormatPlaneCount(dst_image_state->createInfo.format);
1730 aspect = region.dstSubresource.aspectMask;
1731 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1732 std::stringstream ss;
1733 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1734 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1735 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c24, "%s.", ss.str().c_str());
1736 }
1737 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1738 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1739 std::stringstream ss;
1740 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1742 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c26, "%s.", ss.str().c_str());
1743 }
1744 // Multi-plane to single-plane
1745 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1746 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1747 std::stringstream ss;
1748 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1749 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1750 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c28, "%s.", ss.str().c_str());
1751 }
1752 }
1753
1754 return skip;
1755}
1756
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001757bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001758 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1759 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001760 bool skip = false;
1761 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001762 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1763
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001764 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1765
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001766 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001767 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001768
1769 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1770 VkExtent3D src_copy_extent = region.extent;
1771 VkExtent3D dst_copy_extent =
1772 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1773
Dave Houlton6f9059e2017-05-02 17:15:13 -06001774 bool slice_override = false;
1775 uint32_t depth_slices = 0;
1776
1777 // Special case for copying between a 1D/2D array and a 3D image
1778 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1779 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1780 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001781 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001782 slice_override = (depth_slices != 1);
1783 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1784 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001785 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001786 slice_override = (depth_slices != 1);
1787 }
1788
Dave Houltonee281a52017-12-08 13:51:02 -07001789 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001790 std::stringstream ss;
1791 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001792 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001793 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001794 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001795
Dave Houltonee281a52017-12-08 13:51:02 -07001796 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001797 std::stringstream ss;
1798 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001799 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001800 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001801 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001802
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001803 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001804 // No chance of mismatch if we're overriding depth slice count
1805 if (!slice_override) {
1806 // The number of depth slices in srcSubresource and dstSubresource must match
1807 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1808 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001809 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1810 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001811 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001812 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1813 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001814 if (src_slices != dst_slices) {
1815 std::stringstream ss;
1816 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1817 << "] do not match";
1818 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001819 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06001820 }
1821 }
1822 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001823 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001824 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001825 std::stringstream ss;
1826 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1827 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001829 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001830 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001831 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001832
Dave Houltonc991cc92018-03-06 11:08:51 -07001833 // Do multiplane-specific checks, if extension enabled
1834 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1835 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
1836 }
1837
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,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001843 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00112, "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07001844 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001845 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001846
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001847 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001848 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001849 std::stringstream ss;
1850 ss << "vkCmdCopyImage: pRegion[" << i
1851 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1852 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001853 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011c, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001854 }
1855
1856 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001857 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001858 std::stringstream ss;
1859 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1860 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001861 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011e, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001862 }
1863
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001864 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001865 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1866 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867 std::stringstream ss;
1868 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1869 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001870 HandleToUint64(command_buffer), VALIDATION_ERROR_0a600150, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001871 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001872
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001873 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1874 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001875 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1876 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001877 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1878 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001879 HandleToUint64(command_buffer), VALIDATION_ERROR_0a60014e, "%s.", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001880 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001881
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001882 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001883 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001884 std::stringstream ss;
1885 ss << "vkCmdCopyImage: pRegions[" << i
1886 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1887 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001888 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d40, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001889 }
Dave Houltonee281a52017-12-08 13:51:02 -07001890 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001891 std::stringstream ss;
1892 ss << "vkCmdCopyImage: pRegions[" << i
1893 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1894 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001895 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d42, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001896 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001897
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001898 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1899 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001900 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001901 std::stringstream ss;
1902 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001903 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001904 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001905 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d44, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001906 }
Dave Houltonee281a52017-12-08 13:51:02 -07001907 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001908 std::stringstream ss;
1909 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001910 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.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,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001912 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d46, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001913 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001914
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001915 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1916 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1917 // 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 -07001918 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1919 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001920 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001921 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1922 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1923 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1924 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001925 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001926 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f4, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001927 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001928
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001929 // 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 -07001930 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1931 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001932 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001933 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1934 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1935 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1936 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001937 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001938 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f6, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001939 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001940 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001941
Dave Houltonfc1a4052017-04-27 14:32:45 -06001942 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001943 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1944 if (slice_override) src_copy_extent.depth = depth_slices;
1945 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001946 if (extent_check & x_bit) {
1947 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001948 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00120,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001949 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001950 "width [%1d].",
1951 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001952 }
1953
1954 if (extent_check & y_bit) {
1955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001956 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00122,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001958 "height [%1d].",
1959 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001960 }
1961 if (extent_check & z_bit) {
1962 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001963 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00126,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001965 "depth [%1d].",
1966 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001967 }
1968
Dave Houltonee281a52017-12-08 13:51:02 -07001969 // Adjust dest extent if necessary
1970 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1971 if (slice_override) dst_copy_extent.depth = depth_slices;
1972
1973 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001974 if (extent_check & x_bit) {
1975 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001976 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012c,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001977 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001978 "width [%1d].",
1979 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001980 }
1981 if (extent_check & y_bit) {
1982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001983 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012e,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001984 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001985 "height [%1d].",
1986 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001987 }
1988 if (extent_check & z_bit) {
1989 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001990 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00132,
Dave Houltonfc1a4052017-04-27 14:32:45 -06001991 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001992 "depth [%1d].",
1993 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001994 }
1995
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001996 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1997 // must not overlap in memory
1998 if (src_image_state->image == dst_image_state->image) {
1999 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002000 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2001 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002002 std::stringstream ss;
2003 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2004 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002005 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f8, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002006 }
2007 }
2008 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002009 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002010
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002011 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2012 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2013 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002014 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002015 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2016 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002017 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002018 HandleToUint64(command_buffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002019 }
2020 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002021 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2022 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002023 if (srcSize != destSize) {
2024 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2025 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002026 HandleToUint64(command_buffer), VALIDATION_ERROR_1900010e, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002027 }
2028 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002029
Dave Houlton33c22b72017-02-28 13:16:02 -07002030 // Source and dest image sample counts must match
2031 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2032 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2033 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002034 HandleToUint64(command_buffer), VALIDATION_ERROR_19000110, "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002035 }
2036
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002037 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2038 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002039 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002040 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002041 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002042 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002043 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002044 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002045 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002046 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002047 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002048 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002049 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002050 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002051 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002052 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002053 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002054 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2055 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002056 }
2057
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002058 return skip;
2059}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002060
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002061void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002062 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2063 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2064 // Make sure that all image slices are updated to correct layout
2065 for (uint32_t i = 0; i < region_count; ++i) {
2066 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2067 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2068 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002069 // Update bindings between images and cmd buffer
2070 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2071 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002072}
2073
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002074// Returns true if sub_rect is entirely contained within rect
2075static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2076 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2077 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2078 return false;
2079 return true;
2080}
2081
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002082bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2083 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002084 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002085 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2086
2087 bool skip = false;
2088 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002089 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2090 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002091 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002092 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002093 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002094 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2095 // 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 -07002096 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2097 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002098 skip |= log_msg(
2099 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002100 HandleToUint64(commandBuffer), DRAWSTATE_CLEAR_CMD_BEFORE_DRAW,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002101 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2102 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2103 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002104 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002105 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002106 }
2107
2108 // Validate that attachment is in reference list of active subpass
2109 if (cb_node->activeRenderPass) {
2110 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2111 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002112 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002113
2114 for (uint32_t i = 0; i < attachmentCount; i++) {
2115 auto clear_desc = &pAttachments[i];
2116 VkImageView image_view = VK_NULL_HANDLE;
2117
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002118 if (0 == clear_desc->aspectMask) {
2119 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002120 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c03, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002121 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2122 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002123 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00028, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002124 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002125 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002126 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002127 HandleToUint64(commandBuffer), VALIDATION_ERROR_1860001e,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002128 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d.",
2129 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002130 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2131 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002132 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -06002133 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002134 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2135 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002136 } else {
2137 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002138 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002139 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002140 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2141 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2142 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002143 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002144 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002145 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00026, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002146 }
2147 } else { // Must be depth and/or stencil
2148 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2149 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002150 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002151 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002152 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c01, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002153 }
2154 if (!subpass_desc->pDepthStencilAttachment ||
2155 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2156 skip |= log_msg(
2157 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002158 HandleToUint64(commandBuffer), DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002159 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002160 } else {
2161 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2162 }
2163 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002164 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002165 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002166 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002167 // The rectangular region specified by a given element of pRects must be contained within the render area of
2168 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002169 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2170 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2171 skip |=
2172 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002173 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600020,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002174 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002175 "the current render pass instance.",
2176 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002177 }
2178 } else {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002179 const auto local_rect =
2180 pRects[j].rect; // local copy of rect captured by value below to preserve original contents
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002181 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
Tobin Ehlis3faf8b32018-04-17 16:14:26 -06002182 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, local_rect)) {
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002183 return log_msg(
2184 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002185 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600020,
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002186 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002187 "the current render pass instance.",
2188 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002189 }
2190 return false;
2191 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002192 }
2193 // The layers specified by a given element of pRects must be contained within every attachment that
2194 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002195 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002196 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2197 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002199 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600022,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002200 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002201 "of pAttachment[%d].",
2202 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002203 }
2204 }
2205 }
2206 }
2207 }
2208 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002209}
2210
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002211bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002212 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002213 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002214 bool skip = false;
2215 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002216 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2217 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2218 skip |=
2219 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002220 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002221 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002222
2223 // For each region, the number of layers in the image subresource should not be zero
2224 // For each region, src and dest image aspect must be color only
2225 for (uint32_t i = 0; i < regionCount; i++) {
2226 if (pRegions[i].srcSubresource.layerCount == 0) {
2227 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002228 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002229 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002230 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002231 if (pRegions[i].dstSubresource.layerCount == 0) {
2232 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002233 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002234 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002235 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002236 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2237 skip |= log_msg(
2238 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002239 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200216,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002240 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002241 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002242 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2243 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2244 char const str[] =
2245 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2246 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002247 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200214, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002248 }
2249 }
2250
2251 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2252 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002253 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002254 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002255 }
2256 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2257 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002258 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002259 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_TYPE, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002260 }
2261 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2262 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2263 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002264 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_1c800202, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002265 }
2266 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2267 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2268 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002269 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_1c800206, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002270 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002271 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002272 } else {
2273 assert(0);
2274 }
2275 return skip;
2276}
2277
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002278void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2279 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002280 // Update bindings between images and cmd buffer
2281 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2282 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002283}
2284
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002285bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002286 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2287 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002288 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2289
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002290 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002291 if (cb_node) {
2292 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2293 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002294 if (cb_node && src_image_state && dst_image_state) {
2295 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002296 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002297 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002298 VALIDATION_ERROR_184001d4);
2299 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2300 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2301 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2302 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2303 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2304 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2305 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002306 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002307 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002308 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002309
Dave Houlton33c2d252017-06-09 17:08:32 -06002310 VkFormat src_format = src_image_state->createInfo.format;
2311 VkFormat dst_format = dst_image_state->createInfo.format;
2312 VkImageType src_type = src_image_state->createInfo.imageType;
2313 VkImageType dst_type = dst_image_state->createInfo.imageType;
2314
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002315 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002316 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002317 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002318 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2319 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002320 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002321 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature.",
2322 string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002323 }
2324
2325 if ((VK_FILTER_LINEAR == filter) &&
2326 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002327 skip |=
2328 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002329 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002330 "vkCmdBlitImage: source image format %s does not support linear filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002331 }
2332
2333 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2334 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002335 skip |=
2336 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002337 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002338 "vkCmdBlitImage: source image format %s does not support cubic filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002339 }
2340
2341 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2342 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002343 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002344 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002345 }
2346
2347 props = GetFormatProperties(device_data, dst_format);
2348 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002349 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002350 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002351 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002352 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001be,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002353 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature.",
2354 string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002355 }
2356
2357 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2358 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2359 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002360 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001c8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002361 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002362 }
2363
2364 // Validate consistency for unsigned formats
2365 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2366 std::stringstream ss;
2367 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2368 << "the other one must also have unsigned integer format. "
2369 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2370 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002371 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001cc, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002372 }
2373
2374 // Validate consistency for signed formats
2375 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2376 std::stringstream ss;
2377 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2378 << "the other one must also have signed integer format. "
2379 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2380 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002381 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ca, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002382 }
2383
2384 // Validate filter for Depth/Stencil formats
2385 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2386 std::stringstream ss;
2387 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2388 << "then filter must be VK_FILTER_NEAREST.";
2389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002390 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d0, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002391 }
2392
2393 // Validate aspect bits and formats for depth/stencil images
2394 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2395 if (src_format != dst_format) {
2396 std::stringstream ss;
2397 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2398 << "stencil, the other one must have exactly the same format. "
2399 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2400 << string_VkFormat(dst_format);
Mark Lobodzinski88529492018-04-01 10:38:15 -06002401 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2402 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ce, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002403 }
2404
2405#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2406 for (uint32_t i = 0; i < regionCount; i++) {
2407 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2408
2409 if (FormatIsDepthAndStencil(src_format)) {
2410 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2411 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002412 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002413 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2414 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002415 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002416 "%s", ss.str().c_str());
2417 }
2418 }
2419 else if (FormatIsStencilOnly(src_format)) {
2420 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2421 std::stringstream ss;
2422 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2423 << "set in both the srcImage and dstImage";
2424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002425 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002426 "%s", ss.str().c_str());
2427 }
2428 }
2429 else if (FormatIsDepthOnly(src_format)) {
2430 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2431 std::stringstream ss;
2432 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2433 << "set in both the srcImage and dstImage";
2434 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002435 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002436 "%s", ss.str().c_str());
2437 }
2438 }
2439 }
2440#endif
2441 } // Depth or Stencil
2442
2443 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002444 for (uint32_t i = 0; i < region_count; i++) {
2445 const VkImageBlit rgn = regions[i];
2446 bool hit_error = false;
2447 skip |=
2448 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2449 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2450 skip |=
2451 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2452 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002453
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002454 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002455 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2456 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002457 std::stringstream ss;
2458 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2459 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002460 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002461 }
Dave Houlton48989f32017-05-26 15:01:46 -06002462 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2463 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002464 std::stringstream ss;
2465 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2466 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002467 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002468 }
Dave Houlton48989f32017-05-26 15:01:46 -06002469 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002470 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2471 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002472 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002473 }
Dave Houlton48989f32017-05-26 15:01:46 -06002474 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002475 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2476 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002477 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002478 }
2479
2480 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002481 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002482 skip |=
2483 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002484 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001de,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002485 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002486 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002487
Dave Houlton48989f32017-05-26 15:01:46 -06002488 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002489 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002490 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001dc,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002491 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002492 }
Dave Houlton48989f32017-05-26 15:01:46 -06002493
Dave Houlton33c2d252017-06-09 17:08:32 -06002494 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002496 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e2,
Dave Houlton33c2d252017-06-09 17:08:32 -06002497 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002498 "image format %s.",
2499 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002500 }
2501
2502 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2503 skip |= log_msg(
2504 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002505 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002506 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2507 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002508 }
2509
Dave Houlton48989f32017-05-26 15:01:46 -06002510 // Validate source image offsets
2511 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002512 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002513 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2514 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002515 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ea,
Dave Houlton48989f32017-05-26 15:01:46 -06002516 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002517 "of (%1d, %1d). These must be (0, 1).",
2518 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002519 }
2520 }
2521
Dave Houlton33c2d252017-06-09 17:08:32 -06002522 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002523 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2524 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002525 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ee,
Dave Houlton48989f32017-05-26 15:01:46 -06002526 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002527 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2528 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002529 }
2530 }
2531
Dave Houlton33c2d252017-06-09 17:08:32 -06002532 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002533 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2534 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002535 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002536 skip |=
2537 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002538 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002539 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2540 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002541 }
2542 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2543 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002544 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002545 skip |= log_msg(
2546 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002547 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002548 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2549 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002550 }
2551 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2552 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002553 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002554 skip |=
2555 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002556 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ec,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002557 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2558 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002559 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002560 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2561 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002562 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002563 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d.", i,
2564 rgn.srcSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002565 } else if (oob) {
2566 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002567 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002568 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002569 }
Dave Houlton48989f32017-05-26 15:01:46 -06002570
2571 // Validate dest image offsets
2572 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002573 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002574 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2575 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002576 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f4,
Dave Houlton48989f32017-05-26 15:01:46 -06002577 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002578 "(%1d, %1d). These must be (0, 1).",
2579 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002580 }
2581 }
2582
Dave Houlton33c2d252017-06-09 17:08:32 -06002583 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002584 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2585 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002586 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f8,
Dave Houlton48989f32017-05-26 15:01:46 -06002587 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002588 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2589 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002590 }
2591 }
2592
Dave Houlton33c2d252017-06-09 17:08:32 -06002593 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002594 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2595 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002596 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002597 skip |=
2598 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002599 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002600 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
2601 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002602 }
2603 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2604 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002605 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002606 skip |= log_msg(
2607 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002608 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f2,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002609 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
2610 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002611 }
2612 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2613 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002614 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002615 skip |=
2616 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002617 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002618 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
2619 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002620 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002621 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002622 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002623 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002624 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d.", i,
2625 rgn.dstSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002626 } else if (oob) {
2627 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002628 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002629 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002630 }
2631
Dave Houlton33c2d252017-06-09 17:08:32 -06002632 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2633 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2634 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2635 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002636 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e0,
Dave Houlton33c2d252017-06-09 17:08:32 -06002637 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002638 "layerCount other than 1.",
2639 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002640 }
2641 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002642 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002643 } else {
2644 assert(0);
2645 }
2646 return skip;
2647}
2648
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002649void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002650 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2651 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2652 // Make sure that all image slices are updated to correct layout
2653 for (uint32_t i = 0; i < region_count; ++i) {
2654 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2655 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2656 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002657 // Update bindings between images and cmd buffer
2658 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2659 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002660}
2661
Tony Barbourdf013b92017-01-25 12:53:48 -07002662// This validates that the initial layout specified in the command buffer for
2663// the IMAGE is the same
2664// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002665bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002666 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2667 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002668 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002669 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002670 for (auto cb_image_data : pCB->imageLayoutMap) {
2671 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002672
Dave Houltonb3f4b282018-02-22 16:25:16 -07002673 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2674 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002675 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2676 // TODO: Set memory invalid which is in mem_tracker currently
2677 } else if (imageLayout != cb_image_data.second.initialLayout) {
2678 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002679 skip |= log_msg(
2680 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002681 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002682 "Cannot submit cmd buffer using image (0x%" PRIx64
2683 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2684 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2685 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2686 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002687 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002689 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002690 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002691 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2692 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002693 }
2694 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002695 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002696 }
2697 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002698 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002699}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002700
Tony Barbourdf013b92017-01-25 12:53:48 -07002701void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2702 for (auto cb_image_data : pCB->imageLayoutMap) {
2703 VkImageLayout imageLayout;
2704 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2705 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2706 }
2707}
2708
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002709// Print readable FlagBits in FlagMask
2710static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2711 std::string result;
2712 std::string separator;
2713
2714 if (accessMask == 0) {
2715 result = "[None]";
2716 } else {
2717 result = "[";
2718 for (auto i = 0; i < 32; i++) {
2719 if (accessMask & (1 << i)) {
2720 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2721 separator = " | ";
2722 }
2723 }
2724 result = result + "]";
2725 }
2726 return result;
2727}
2728
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002729// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2730// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002731// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002732static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2733 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2734 const char *type) {
2735 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2736 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002737
2738 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2739 if (accessMask & ~(required_bit | optional_bits)) {
2740 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002741 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002742 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002743 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2744 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002745 }
2746 } else {
2747 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002748 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002749 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002750 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2751 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002752 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2753 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002754 } else {
2755 std::string opt_bits;
2756 if (optional_bits != 0) {
2757 std::stringstream ss;
2758 ss << optional_bits;
2759 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2760 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002761 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002762 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002763 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2764 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002765 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2766 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002767 }
2768 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002769 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002770}
2771
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002772// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002773// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2774// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002775bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002776 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2777 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002778 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2779 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2780 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2781 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002782 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002783 VALIDATION_ERROR_12200688, "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002784 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002785 }
2786 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02002787 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2788 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
2789 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2790 VALIDATION_ERROR_12200c3c, "Cannot clear attachment %d with invalid first layout %s.", attachment,
2791 string_VkImageLayout(first_layout));
2792 }
2793 }
2794
2795 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2796 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
2797 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2798 VALIDATION_ERROR_12200c3e, "Cannot clear attachment %d with invalid first layout %s.", attachment,
2799 string_VkImageLayout(first_layout));
2800 }
2801 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002802 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002803}
2804
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002805bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2806 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002807 bool skip = false;
2808
Jason Ekstranda1906302017-12-03 20:16:32 -08002809 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2810 VkFormat format = pCreateInfo->pAttachments[i].format;
2811 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2812 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2813 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002814 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002815 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002816 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2817 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2818 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2819 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002820 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002821 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002822 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002823 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002824 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2825 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2826 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2827 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002828 }
2829 }
2830 }
2831
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002832 // Track when we're observing the first use of an attachment
2833 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2834 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2835 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002836
2837 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2838 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2839 auto attach_index = subpass.pInputAttachments[j].attachment;
2840 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2841
2842 switch (subpass.pInputAttachments[j].layout) {
2843 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2844 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2845 // These are ideal.
2846 break;
2847
2848 case VK_IMAGE_LAYOUT_GENERAL:
2849 // May not be optimal. TODO: reconsider this warning based on other constraints.
2850 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002851 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002852 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2853 break;
2854
2855 default:
2856 // No other layouts are acceptable
2857 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002858 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002859 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2860 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2861 }
2862
2863 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2864 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2865 subpass.pDepthStencilAttachment->attachment == attach_index &&
2866 subpass.pDepthStencilAttachment->layout != layout;
2867 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2868 found_layout_mismatch =
2869 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2870 }
2871 if (found_layout_mismatch) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002873 VALIDATION_ERROR_140006ae,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002874 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002875 "depth/color attachment with a different layout.",
2876 i, j, attach_index, layout);
Cort Stratton7547f772017-05-04 15:18:52 -07002877 }
2878
2879 if (attach_first_use[attach_index]) {
2880 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2881 pCreateInfo->pAttachments[attach_index]);
2882
2883 bool used_as_depth =
2884 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2885 bool used_as_color = false;
2886 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2887 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2888 }
2889 if (!used_as_depth && !used_as_color &&
2890 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2891 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002892 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002893 VALIDATION_ERROR_1400069c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002894 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
2895 attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07002896 }
2897 }
2898 attach_first_use[attach_index] = false;
2899 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002900 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2901 auto attach_index = subpass.pColorAttachments[j].attachment;
2902 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2903
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002904 // TODO: Need a way to validate shared presentable images here, currently just allowing
2905 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2906 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002907 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002908 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002909 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002910 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2911 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002912 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002913
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002914 case VK_IMAGE_LAYOUT_GENERAL:
2915 // May not be optimal; TODO: reconsider this warning based on other constraints?
2916 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002917 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002918 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2919 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002920
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002921 default:
2922 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002923 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002924 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2925 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002926 }
2927
2928 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002929 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2930 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002931 }
2932 attach_first_use[attach_index] = false;
2933 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002934
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002935 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2936 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002937 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2938 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2939 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06002940 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06002941
Dave Houltona9df0ce2018-02-07 10:51:23 -07002942 case VK_IMAGE_LAYOUT_GENERAL:
2943 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2944 // doing a bunch of transitions.
2945 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002946 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002947 "GENERAL layout for depth attachment may not give optimal performance.");
2948 break;
2949
2950 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2951 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2952 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2953 break;
2954 } else {
2955 // Intentionally fall through to generic error message
2956 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002957 // fall through
Dave Houltona9df0ce2018-02-07 10:51:23 -07002958 default:
2959 // No other layouts are acceptable
2960 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002961 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002962 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2963 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2964 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002965 }
2966
2967 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2968 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002969 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2970 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002971 }
2972 attach_first_use[attach_index] = false;
2973 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002974 }
2975 return skip;
2976}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002977
2978// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002979bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2980 VkDeviceSize offset, VkDeviceSize end_offset) {
2981 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2982 bool skip = false;
2983 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2984 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002985 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2986 for (auto image_handle : mem_info->bound_images) {
2987 auto img_it = mem_info->bound_ranges.find(image_handle);
2988 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002989 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002990 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002991 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002992 for (auto layout : layouts) {
2993 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002994 skip |=
2995 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002996 HandleToUint64(mem_info->mem), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002997 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
2998 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002999 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003000 }
3001 }
3002 }
3003 }
3004 }
3005 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003006 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003007}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003008
3009// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3010// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003011static 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 -06003012 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003013 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003014
3015 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003016 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003017 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003018 if (strict) {
3019 correct_usage = ((actual & desired) == desired);
3020 } else {
3021 correct_usage = ((actual & desired) != 0);
3022 }
3023 if (!correct_usage) {
3024 if (msgCode == -1) {
3025 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003026 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003027 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003028 MEMTRACK_INVALID_USAGE_FLAG,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003029 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3030 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003031 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003032 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003033 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003034 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3035 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003036 }
3037 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003038 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003039}
3040
3041// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3042// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003043bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003044 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003045 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3046 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003047}
3048
3049// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3050// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003051bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003052 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003053 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3054 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003055}
3056
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003057bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003058 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003059 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3060
Chris Forbese0f511c2017-06-14 12:38:01 -07003061 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003062
3063 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003064 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003065 VALIDATION_ERROR_01400726,
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003066 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003067 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003068 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003069
3070 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003071 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003072 VALIDATION_ERROR_01400728,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003073 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003074 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003075 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003076
3077 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003078 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003079 VALIDATION_ERROR_0140072a,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003080 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003081 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003082 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003083 return skip;
3084}
3085
3086void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3087 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3088 GetBufferMap(device_data)
3089 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3090}
3091
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003092bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3093 bool skip = false;
3094 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003095 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3096 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003097 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003098 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3099 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003100 skip |= ValidateBufferUsageFlags(
3101 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 -06003102 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003103 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003104 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003105}
3106
3107void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3108 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3109}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003110
3111// For the given format verify that the aspect masks make sense
3112bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3113 const char *func_name) {
3114 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3115 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003116 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003117 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003118 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003119 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003120 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003121 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003122 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003123 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003124 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003125 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003126 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003127 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003128 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003129 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003130 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003131 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3132 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003133 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003134 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003135 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003136 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003137 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3138 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003139 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003140 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003141 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003142 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003143 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003144 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003145 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003146 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003147 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003148 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003149 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003150 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003151 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003152 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003153 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003154 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003155 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003156 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003157 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003158 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003159 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003160 } else if (FormatIsMultiplane(format)) {
3161 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3162 if (3 == FormatPlaneCount(format)) {
3163 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3164 }
3165 if ((aspect_mask & valid_flags) != aspect_mask) {
3166 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3167 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
3168 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3169 "set, where n = [0, 1, 2].",
3170 func_name);
3171 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003172 }
3173 return skip;
3174}
3175
Petr Krausffa94af2017-08-08 21:46:02 +02003176struct SubresourceRangeErrorCodes {
3177 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3178};
3179
3180bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3181 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3182 const char *image_layer_count_var_name, const uint64_t image_handle,
3183 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003184 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3185 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003186
3187 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003188 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003190 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003191 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003192 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3193 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003194 }
Petr Kraus4d718682017-05-18 03:38:41 +02003195
Petr Krausffa94af2017-08-08 21:46:02 +02003196 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3197 if (subresourceRange.levelCount == 0) {
3198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003199 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003200 } else {
3201 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003202
Petr Krausffa94af2017-08-08 21:46:02 +02003203 if (necessary_mip_count > image_mip_count) {
3204 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003205 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003206 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003207 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003208 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003209 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003210 }
Petr Kraus4d718682017-05-18 03:38:41 +02003211 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003212 }
Petr Kraus4d718682017-05-18 03:38:41 +02003213
3214 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003215 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003216 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003217 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003218 "%s: %s.baseArrayLayer (= %" PRIu32
3219 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3220 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003221 }
Petr Kraus4d718682017-05-18 03:38:41 +02003222
Petr Krausffa94af2017-08-08 21:46:02 +02003223 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3224 if (subresourceRange.layerCount == 0) {
3225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003226 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003227 } else {
3228 const uint64_t necessary_layer_count =
3229 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003230
Petr Krausffa94af2017-08-08 21:46:02 +02003231 if (necessary_layer_count > image_layer_count) {
3232 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003233 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003234 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003235 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003236 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003237 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003238 }
Petr Kraus4d718682017-05-18 03:38:41 +02003239 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003240 }
Petr Kraus4d718682017-05-18 03:38:41 +02003241
Mark Lobodzinski602de982017-02-09 11:01:33 -07003242 return skip;
3243}
3244
Petr Krausffa94af2017-08-08 21:46:02 +02003245bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3246 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3247 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3248 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3249 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3250 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3251
3252 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3253 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3254
3255 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3256 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003257 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00d6c;
Petr Krausffa94af2017-08-08 21:46:02 +02003258 subresourceRangeErrorCodes.base_layer_err =
3259 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3260 subresourceRangeErrorCodes.layer_count_err =
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003261 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00d6e;
Petr Krausffa94af2017-08-08 21:46:02 +02003262
3263 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3264 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3265 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3266}
3267
3268bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3269 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3270 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3271 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003272 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800d38;
Petr Krausffa94af2017-08-08 21:46:02 +02003273 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003274 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800d3a;
Petr Krausffa94af2017-08-08 21:46:02 +02003275
3276 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3277 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3278 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3279}
3280
3281bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3282 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3283 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3284 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003285 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00d3c;
Petr Krausffa94af2017-08-08 21:46:02 +02003286 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003287 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00d3e;
Petr Krausffa94af2017-08-08 21:46:02 +02003288
3289 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3290 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3291 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3292}
3293
3294bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3295 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3296 const char *param_name) {
3297 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3298 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003299 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000d78;
Petr Krausffa94af2017-08-08 21:46:02 +02003300 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003301 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000d7a;
Petr Krausffa94af2017-08-08 21:46:02 +02003302
3303 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3304 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3305 subresourceRangeErrorCodes);
3306}
3307
Mark Lobodzinski602de982017-02-09 11:01:33 -07003308bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3309 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3310 bool skip = false;
3311 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3312 if (image_state) {
3313 skip |= ValidateImageUsageFlags(
3314 device_data, image_state,
3315 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003316 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003317 false, -1, "vkCreateImageView()",
3318 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3319 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003320 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003321 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003322 skip |= ValidateCreateImageViewSubresourceRange(
3323 device_data, image_state,
3324 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3325 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003326
3327 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3328 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003329 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3330 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003331 VkFormat view_format = create_info->format;
3332 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003333 VkImageType image_type = image_state->createInfo.imageType;
3334 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003335
Dave Houltonbd2e2622018-04-10 16:41:14 -06003336 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
3337 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
3338 if (chained_ivuci_struct) {
3339 if (chained_ivuci_struct->usage & ~image_usage) {
3340 std::stringstream ss;
3341 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06003342 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06003343 << image_usage << ").";
3344 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3345 VALIDATION_ERROR_3f200c66, "%s", ss.str().c_str());
3346 }
3347
3348 image_usage = chained_ivuci_struct->usage;
3349 }
3350
Mark Lobodzinski602de982017-02-09 11:01:33 -07003351 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3352 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Dave Houltonc7988072018-04-16 11:46:56 -06003353 if (FormatIsMultiplane(image_format)) {
3354 // View format must match the multiplane compatible format
3355 uint32_t plane = 3; // invalid
3356 switch (aspect_mask) {
3357 case VK_IMAGE_ASPECT_PLANE_0_BIT:
3358 plane = 0;
3359 break;
3360 case VK_IMAGE_ASPECT_PLANE_1_BIT:
3361 plane = 1;
3362 break;
3363 case VK_IMAGE_ASPECT_PLANE_2_BIT:
3364 plane = 2;
3365 break;
3366 default:
3367 break;
3368 }
3369
3370 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
3371 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003372 std::stringstream ss;
3373 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06003374 << " is not compatible with plane " << plane << " of underlying image format "
3375 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Lenny Komowb79f04a2017-09-18 17:07:00 -06003376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltonc7988072018-04-16 11:46:56 -06003377 VALIDATION_ERROR_0ac00c64, "%s", ss.str().c_str());
3378 }
3379 } else {
3380 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 VALIDATION_ERROR_0ac007f4, "%s", ss.str().c_str());
3392 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003393 }
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 Lobodzinskib1fd9d12018-03-30 14:26:00 -06003402 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003403 VALIDATION_ERROR_0ac007f6, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07003404 }
3405 }
3406
3407 // Validate correct image aspect bits for desired formats and format consistency
3408 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003409
3410 switch (image_type) {
3411 case VK_IMAGE_TYPE_1D:
3412 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003414 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003415 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3416 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003417 }
3418 break;
3419 case VK_IMAGE_TYPE_2D:
3420 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3421 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3422 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3423 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003424 VALIDATION_ERROR_0ac007d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003425 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3426 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003427 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3428 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003429 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003430 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3431 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003432 }
3433 }
3434 break;
3435 case VK_IMAGE_TYPE_3D:
3436 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3437 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3438 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3439 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003440 skip |=
3441 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003442 VALIDATION_ERROR_0ac007da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003443 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3444 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003445 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3446 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003447 skip |=
3448 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003449 VALIDATION_ERROR_0ac007fa,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003450 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3451 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003452 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
3453 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003454 }
3455 } else {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003456 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003457 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003458 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3459 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003460 }
3461 }
3462 } else {
3463 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3464 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003465 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003466 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3467 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003468 }
3469 }
3470 break;
3471 default:
3472 break;
3473 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003474
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003475 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003476 bool check_tiling_features = false;
3477 VkFormatFeatureFlags tiling_features = 0;
3478 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3479 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3480 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3481 };
3482 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3483 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3484 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3485 };
3486 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3487 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003488 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003489 error_codes = linear_error_codes;
3490 check_tiling_features = true;
3491 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003492 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003493 error_codes = optimal_error_codes;
3494 check_tiling_features = true;
3495 }
3496
3497 if (check_tiling_features) {
3498 if (tiling_features == 0) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003499 skip |=
3500 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[0],
3501 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
3502 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003503 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003504 skip |=
3505 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[1],
3506 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3507 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
3508 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003509 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003510 skip |=
3511 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[2],
3512 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3513 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
3514 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003515 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3516 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003517 skip |=
3518 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[3],
3519 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3520 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
3521 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003522 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3523 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003524 skip |=
3525 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[4],
3526 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3527 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
3528 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003529 }
3530 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003531 }
3532 return skip;
3533}
3534
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003535void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3536 auto image_view_map = GetImageViewMap(device_data);
3537 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3538
3539 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003540 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003541 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3542 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003543}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003544
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003545bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3546 BUFFER_STATE *dst_buffer_state) {
3547 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003548 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3549 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003550 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003551 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3552 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3553 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3554 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003555 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003556 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003557 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003558 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003559 return skip;
3560}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003561
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003562void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3563 BUFFER_STATE *dst_buffer_state) {
3564 // Update bindings between buffers and cmd buffer
3565 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3566 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003567}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003568
3569static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3570 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3571 bool skip = false;
3572 auto buffer_state = GetBufferState(device_data, buffer);
3573 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003574 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -06003575 DRAWSTATE_DOUBLE_DESTROY, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01003576 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003577 } else {
3578 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003579 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003580 HandleToUint64(buffer), VALIDATION_ERROR_23c00734,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003581 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003582 }
3583 }
3584 return skip;
3585}
3586
3587bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3588 VK_OBJECT *obj_struct) {
3589 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003590 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003591 if (GetDisables(device_data)->destroy_image_view) return false;
3592 bool skip = false;
3593 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003594 skip |=
3595 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003596 }
3597 return skip;
3598}
3599
John Zulauffca05c12018-04-26 16:30:39 -06003600void PreCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3601 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003602 // Any bound cmd buffers are now invalid
3603 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3604 (*GetImageViewMap(device_data)).erase(image_view);
3605}
3606
3607bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3608 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003609 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003610 if (GetDisables(device_data)->destroy_buffer) return false;
3611 bool skip = false;
3612 if (*buffer_state) {
3613 skip |= validateIdleBuffer(device_data, buffer);
3614 }
3615 return skip;
3616}
3617
John Zulauffca05c12018-04-26 16:30:39 -06003618void PreCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003619 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3620 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3621 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3622 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003623 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003624 }
3625 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003626 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003627 GetBufferMap(device_data)->erase(buffer_state->buffer);
3628}
3629
3630bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3631 VK_OBJECT *obj_struct) {
3632 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003633 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003634 if (GetDisables(device_data)->destroy_buffer_view) return false;
3635 bool skip = false;
3636 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003637 skip |=
3638 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003639 }
3640 return skip;
3641}
3642
John Zulauffca05c12018-04-26 16:30:39 -06003643void PreCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3644 VK_OBJECT obj_struct) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003645 // Any bound cmd buffers are now invalid
3646 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3647 GetBufferViewMap(device_data)->erase(buffer_view);
3648}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003649
3650bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3651 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003652 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003653 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003654 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003655 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3656 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003657 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003658 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003659 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003660 return skip;
3661}
3662
3663void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003664 // Update bindings between buffer and cmd buffer
3665 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003666}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003667
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003668bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3669 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003670 bool skip = false;
3671
3672 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003673 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3674 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003675 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003676 HandleToUint64(image_state->image), VALIDATION_ERROR_0160018e,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003677 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003678 "and 1, respectively.",
3679 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003680 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003681 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003682
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003683 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3684 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003685 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003686 HandleToUint64(image_state->image), VALIDATION_ERROR_01600192,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003687 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003688 "must be 0 and 1, respectively.",
3689 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003690 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003691 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003692
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003693 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3694 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003695 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003696 HandleToUint64(image_state->image), VALIDATION_ERROR_016001aa,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003697 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3698 "For 3D images these must be 0 and 1, respectively.",
3699 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003700 }
3701 }
3702
3703 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3704 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003705 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003706 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003707 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003708 HandleToUint64(image_state->image), VALIDATION_ERROR_01600182,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003709 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003710 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
3711 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003712 }
3713
3714 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003715 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003717 HandleToUint64(image_state->image), VALIDATION_ERROR_01600184,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003718 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
3719 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003720 }
3721
3722 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3723 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003724 skip |=
3725 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003726 HandleToUint64(image_state->image), VALIDATION_ERROR_01600186,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003727 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
3728 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003729 }
3730
3731 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3732 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3733 skip |= log_msg(
3734 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003735 HandleToUint64(image_state->image), VALIDATION_ERROR_01600188,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003736 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
3737 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003738 }
3739
3740 // subresource aspectMask must have exactly 1 bit set
3741 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3742 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3743 if (aspect_mask_bits.count() != 1) {
3744 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003745 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003746 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003747 }
3748
3749 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003750 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003751 skip |= log_msg(
3752 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003753 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003754 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
3755 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003756 }
3757
3758 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04003759 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003760 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003761
3762 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003763 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003764 skip |= log_msg(
3765 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003766 HandleToUint64(image_state->image), VALIDATION_ERROR_01600196,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003767 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
3768 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003769 }
3770
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003771 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003772 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003773 skip |= log_msg(
3774 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003775 HandleToUint64(image_state->image), VALIDATION_ERROR_01600198,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003776 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
3777 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003778 }
3779
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003780 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003781 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3782 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3783 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003784 skip |=
3785 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003786 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019a,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003787 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3788 "width & height (%d, %d)..",
3789 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003790 }
3791
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003792 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003793 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3794 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003795 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003796 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003797 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3798 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
3799 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003800 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003801
3802 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003803 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003804 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003805 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3806 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003807 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019e,
Dave Houlton75967fc2017-03-06 17:21:16 -07003808 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003809 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003810 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003811 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07003812 }
3813
3814 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003815 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003816 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3817 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003818 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a0,
Dave Houlton75967fc2017-03-06 17:21:16 -07003819 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003820 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003821 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003822 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07003823 }
3824
3825 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003826 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003827 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003829 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a2,
Dave Houlton75967fc2017-03-06 17:21:16 -07003830 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003831 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003832 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003833 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07003834 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003835 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003836 }
3837
3838 return skip;
3839}
3840
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003841static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3842 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003843 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003844 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003845
3846 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003847 VkExtent3D extent = pRegions[i].imageExtent;
3848 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003849
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003850 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3851 {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003852 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3853 (uint64_t)0, IMAGE_ZERO_AREA_SUBREGION, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
3854 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003855 }
3856
3857 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3858
3859 // 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 -06003860 if (FormatIsCompressed(image_info->format)) {
3861 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003862 if (image_extent.width % block_extent.width) {
3863 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3864 }
3865 if (image_extent.height % block_extent.height) {
3866 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3867 }
3868 if (image_extent.depth % block_extent.depth) {
3869 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3870 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003871 }
3872
Dave Houltonfc1a4052017-04-27 14:32:45 -06003873 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003874 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003875 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003876 }
3877 }
3878
3879 return skip;
3880}
3881
Chris Forbese8ba09a2017-06-01 17:39:02 -07003882static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003883 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3884 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003885 bool skip = false;
3886
3887 VkDeviceSize buffer_size = buff_state->createInfo.size;
3888
3889 for (uint32_t i = 0; i < regionCount; i++) {
3890 VkExtent3D copy_extent = pRegions[i].imageExtent;
3891
3892 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3893 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003894 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003895
Dave Houltonf3229d52017-02-21 15:59:08 -07003896 // Handle special buffer packing rules for specific depth/stencil formats
3897 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003898 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003899 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3900 switch (image_state->createInfo.format) {
3901 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003902 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003903 break;
3904 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003905 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003906 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003907 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003908 case VK_FORMAT_D24_UNORM_S8_UINT:
3909 unit_size = 4;
3910 break;
3911 default:
3912 break;
3913 }
3914 }
3915
Dave Houlton1d2022c2017-03-29 11:43:58 -06003916 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003917 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003918 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003919 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3920 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3921
3922 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3923 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3924 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003925 }
3926
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003927 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3928 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3929 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003930 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003931 } else {
3932 // Calculate buffer offset of final copied byte, + 1.
3933 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3934 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3935 max_buffer_offset *= unit_size; // convert to bytes
3936 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003937
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003938 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003939 skip |=
3940 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3941 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003942 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003943 }
3944 }
3945
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003946 return skip;
3947}
3948
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003949bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003950 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003951 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003952 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3953 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3954
3955 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07003956 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003957
3958 // Command pool must support graphics, compute, or transfer operations
3959 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3960
3961 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3962 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3963 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003964 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_19202415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003965 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003966 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003967 }
Dave Houlton0ef27492018-04-04 11:41:48 -06003968 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003969 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07003970 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06003971 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003972
3973 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003974 VALIDATION_ERROR_19200178);
3975 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
3976 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003977
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003978 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003979 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003980 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003981 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3982 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
3983 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003984 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003985 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003986 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
3987 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
3988 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003989 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Cort Stratton420ebd42018-05-04 01:12:23 -04003990 "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200e04);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003991 }
3992 return skip;
3993}
3994
3995void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003996 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
3997 VkImageLayout src_image_layout) {
3998 // Make sure that all image slices are updated to correct layout
3999 for (uint32_t i = 0; i < region_count; ++i) {
4000 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4001 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004002 // Update bindings between buffer/image and cmd buffer
4003 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004004 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004005}
4006
4007bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004008 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004009 const VkBufferImageCopy *pRegions, const char *func_name) {
4010 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4011 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4012
4013 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004014 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004015
4016 // Command pool must support graphics, compute, or transfer operations
4017 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4018 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4019 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4020 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004021 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_18e02415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004022 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004023 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004024 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004025 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004026 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004027 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004028 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004029 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004030 VALIDATION_ERROR_18e00166);
4031 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4032 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4033 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4034 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4035 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004036 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004037 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004038 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004039 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004040 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4041 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4042 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004043 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Cort Stratton420ebd42018-05-04 01:12:23 -04004044 "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00e02);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004045 }
4046 return skip;
4047}
4048
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004049void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004050 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4051 VkImageLayout dst_image_layout) {
4052 // Make sure that all image slices are updated to correct layout
4053 for (uint32_t i = 0; i < region_count; ++i) {
4054 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4055 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004056 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004057 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004058}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004059
4060bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4061 const auto report_data = core_validation::GetReportData(device_data);
4062 bool skip = false;
4063 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4064
Dave Houlton1d960ff2018-01-19 12:17:05 -07004065 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004066 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4067 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4068 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004069 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mark Lobodzinski88529492018-04-01 10:38:15 -06004070 VALIDATION_ERROR_2a6007ca,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004071 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004072 }
4073
4074 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4075 if (!image_entry) {
4076 return skip;
4077 }
4078
Dave Houlton1d960ff2018-01-19 12:17:05 -07004079 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004080 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004081 skip |=
4082 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4083 VALIDATION_ERROR_2a6007c8, "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004084 }
4085
Dave Houlton1d960ff2018-01-19 12:17:05 -07004086 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004087 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004088 skip |=
4089 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4090 VALIDATION_ERROR_2a600d68, "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.",
4091 pSubresource->mipLevel, image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004092 }
4093
Dave Houlton1d960ff2018-01-19 12:17:05 -07004094 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004095 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004096 skip |=
4097 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4098 VALIDATION_ERROR_2a600d6a, "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4099 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004100 }
4101
Dave Houlton1d960ff2018-01-19 12:17:05 -07004102 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004103 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004104 if (FormatIsMultiplane(img_format)) {
4105 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4106 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4107 if (FormatPlaneCount(img_format) > 2u) {
4108 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4109 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4110 }
4111 if (sub_aspect != (sub_aspect & allowed_flags)) {
4112 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004113 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004114 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004115 ") must be a single-plane specifier flag.",
4116 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004117 }
4118 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004119 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004120 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004121 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mark Lobodzinski88529492018-04-01 10:38:15 -06004122 VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004123 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004124 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004125 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004126 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004127 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004128 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mike Weiblen672b58b2017-02-21 14:32:53 -07004129 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004130 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004131 }
4132 }
4133 return skip;
4134}