blob: 0b9e1f1ef1ef9563a57ec6363770d6e0de5fe36b [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 bool optimal_tiling = (VK_IMAGE_TILING_OPTIMAL == pCreateInfo->tiling);
711 const char *tiling_string = string_VkImageTiling(pCreateInfo->tiling);
712 const char *format_string = string_VkFormat(pCreateInfo->format);
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600713 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700714 VkFormatFeatureFlags features = (optimal_tiling ? properties.optimalTilingFeatures : properties.linearTilingFeatures);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600715
Dave Houlton130c0212018-01-29 13:39:56 -0700716 if (0 == features) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600717 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700718 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ac : VALIDATION_ERROR_09e007a2);
719 ss << "vkCreateImage format parameter " << format_string << " is an unsupported format";
Mark Lobodzinski88529492018-04-01 10:38:15 -0600720 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
721 ss.str().c_str());
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600722 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600723 }
724
Lenny Komowb79f04a2017-09-18 17:07:00 -0600725 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
Dave Houltonbd2e2622018-04-10 16:41:14 -0600726 // For EXTENDED_USAGE images, any usage bit set for any format compatible with image format becomes legal
727 // For now we'll just avoid the usage bit checks for EXTENDED_USAGE images, pending an implementation of
728 // an exhaustive search of compatible formats
Lenny Komowb79f04a2017-09-18 17:07:00 -0600729 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
Dave Houltonbd2e2622018-04-10 16:41:14 -0600730 if ((pCreateInfo->usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
731 std::stringstream ss;
732 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ae : VALIDATION_ERROR_09e007a4);
733 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_SAMPLED_BIT is not supported for format " << format_string
734 << " with tiling " << tiling_string;
735 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
736 ss.str().c_str());
737 }
738
739 if ((pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
740 std::stringstream ss;
741 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b0 : VALIDATION_ERROR_09e007a6);
742 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_STORAGE_BIT is not supported for format " << format_string
743 << " with tiling " << tiling_string;
744 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
745 ss.str().c_str());
746 }
747
Lenny Komowb79f04a2017-09-18 17:07:00 -0600748 // Validate that format supports usage as color attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700749 if ((pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
750 (0 == (features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))) {
751 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b2 : VALIDATION_ERROR_09e007a8);
752 std::stringstream ss;
753 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_COLOR_ATTACHMENT is not supported for format " << format_string
754 << " with tiling " << tiling_string;
Mark Lobodzinski88529492018-04-01 10:38:15 -0600755 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
756 ss.str().c_str());
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600757 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600758
Lenny Komowb79f04a2017-09-18 17:07:00 -0600759 // Validate that format supports usage as depth/stencil attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700760 if ((pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
761 (0 == (features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
762 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b4 : VALIDATION_ERROR_09e007aa);
763 std::stringstream ss;
764 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT is not supported for format " << format_string
765 << " with tiling " << tiling_string;
Mark Lobodzinski88529492018-04-01 10:38:15 -0600766 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid, "%s.",
767 ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700768 }
769 }
770
771 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
772 std::stringstream ss;
773 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 -0600774 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 -0600775 VALIDATION_ERROR_09e0076a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700776 }
777
778 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
779 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
780 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
781 if (VK_SUCCESS != err) {
782 std::stringstream ss;
783 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
784 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600785 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 -0600786 VALIDATION_ERROR_09e00758, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700787 return skip;
788 }
789
790 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
791 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
792 std::stringstream ss;
793 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600794 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 -0600795 VALIDATION_ERROR_09e0076e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700796 }
797
798 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
799 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
800 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
801 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600802 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700803 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600804 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 -0600805 VALIDATION_ERROR_09e00770, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600806 }
Dave Houlton130c0212018-01-29 13:39:56 -0700807 } else {
808 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
809 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600810 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700811 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
812 "format "
813 << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600814 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 -0600815 VALIDATION_ERROR_09e00772, "%s.", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -0600816 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600817 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700818 }
819
Dave Houlton130c0212018-01-29 13:39:56 -0700820 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
821 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
822 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
823 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
824 std::stringstream ss;
825 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600826 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 -0600827 VALIDATION_ERROR_09e00776, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700828 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700829 }
830
Dave Houlton130c0212018-01-29 13:39:56 -0700831 // 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 -0700832 // 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 -0700833 // implementation shown. DJH
834 //
835 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
836 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
837 // device_limits->maxImageDimension3D)) {
838 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
839 std::stringstream ss;
840 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600841 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 -0600842 VALIDATION_ERROR_09e0077e, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700843 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700844
Dave Houlton130c0212018-01-29 13:39:56 -0700845 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
846 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
847 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
848 std::stringstream ss;
849 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
850 "maxFramebufferWidth";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600851 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 -0600852 VALIDATION_ERROR_09e00788, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700853 }
854
855 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
856 std::stringstream ss;
857 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
858 "maxFramebufferHeight";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600859 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 -0600860 VALIDATION_ERROR_09e0078a, "%s.", ss.str().c_str());
Dave Houlton130c0212018-01-29 13:39:56 -0700861 }
862
863 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
864 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
865 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
866
867 // Round up to imageGranularity boundary
868 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
869 uint64_t ig_mask = imageGranularity - 1;
870 total_size = (total_size + ig_mask) & ~ig_mask;
871
872 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600873 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 -0600874 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700875 "CreateImage resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
876 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700877 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700878 }
879
Dave Houlton130c0212018-01-29 13:39:56 -0700880 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600881 skip |=
882 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 -0600883 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d.", pCreateInfo->arrayLayers,
884 format_limits.maxArrayLayers);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700885 }
886
Dave Houlton130c0212018-01-29 13:39:56 -0700887 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600888 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 -0600889 VALIDATION_ERROR_09e0078e, "CreateImage samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600890 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700891 }
892
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600893 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600894 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 -0600895 DRAWSTATE_INVALID_FEATURE,
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600896 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
897 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600898 }
899
Lenny Komowb79f04a2017-09-18 17:07:00 -0600900 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
901 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
902 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
903 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
904 // TODO: Add Maintenance2 VUID
905 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600906 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 -0600907 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600908 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
909 "format must be block, ETC or ASTC compressed, but is %s",
910 string_VkFormat(pCreateInfo->format));
911 }
912 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
913 // TODO: Add Maintenance2 VUID
914 skip |=
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600915 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 -0600916 VALIDATION_ERROR_UNDEFINED,
Lenny Komowb79f04a2017-09-18 17:07:00 -0600917 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
918 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
919 }
920 }
921 }
922
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600923 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700924}
925
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700926void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700927 IMAGE_LAYOUT_NODE image_state;
928 image_state.layout = pCreateInfo->initialLayout;
929 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700930 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 -0700931 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700932 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
933 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700934}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700935
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700936bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700937 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700938 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200939 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700940 if (disabled->destroy_image) return false;
941 bool skip = false;
942 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600943 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
944 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700945 }
946 return skip;
947}
948
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700949void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700950 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
951 // Clean up memory mapping, bindings and range references for image
952 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700953 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700954 if (mem_info) {
955 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
956 }
957 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600958 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700959 // Remove image from imageMap
960 core_validation::GetImageMap(device_data)->erase(image);
961 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
962 core_validation::GetImageSubresourceMap(device_data);
963
964 const auto &sub_entry = imageSubresourceMap->find(image);
965 if (sub_entry != imageSubresourceMap->end()) {
966 for (const auto &pair : sub_entry->second) {
967 core_validation::GetImageLayoutMap(device_data)->erase(pair);
968 }
969 imageSubresourceMap->erase(sub_entry);
970 }
971}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700972
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700973bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700974 bool skip = false;
975 const debug_report_data *report_data = core_validation::GetReportData(device_data);
976
977 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
978 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
979 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), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700981 }
982
Dave Houlton1d2022c2017-03-29 11:43:58 -0600983 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700984 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
985 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 -0600986 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600987 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700988 char const str[] = "vkCmdClearColorImage called with compressed image.";
989 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 -0600990 HandleToUint64(image_state->image), VALIDATION_ERROR_1880000e, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700991 }
992
993 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
994 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
995 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 -0600996 HandleToUint64(image_state->image), VALIDATION_ERROR_18800004, "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700997 }
998 return skip;
999}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001000
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001001uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1002 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1003 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001004 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001005 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001006 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001007 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001008}
1009
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001010uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1011 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1012 uint32_t array_layer_count = range->layerCount;
1013 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1014 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001015 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001016 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001017}
1018
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001019bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001020 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
1021 bool skip = false;
1022 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1023
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001024 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1025 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001026
1027 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1028 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001029 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1030 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001031 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 -06001032 HandleToUint64(image_state->image), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001033 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1034 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001035 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001036 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001037 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001038 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 -06001039 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001040 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1041 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001042
1043 } else {
1044 if (image_state->shared_presentable) {
1045 skip |= log_msg(
1046 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001047 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001048 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1049 string_VkImageLayout(dest_image_layout));
1050 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001051 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001052 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001053 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001054 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001055 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001056 } else {
1057 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1058 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001059 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 -06001060 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001061 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1062 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001063 }
1064 }
1065
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001066 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1067 uint32_t level = level_index + range.baseMipLevel;
1068 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1069 uint32_t layer = layer_index + range.baseArrayLayer;
1070 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001071 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001072 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001073 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001074 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001075 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001076 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001077 } else {
1078 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1079 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001080 skip |=
1081 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1082 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1083 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001084 }
1085 }
1086 }
1087 }
1088
1089 return skip;
1090}
1091
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001092void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1093 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001094 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1095 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1096 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001097
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001098 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1099 uint32_t level = level_index + range.baseMipLevel;
1100 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1101 uint32_t layer = layer_index + range.baseArrayLayer;
1102 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001103 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001104 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1105 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 -07001106 }
1107 }
1108 }
1109}
1110
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001111bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001112 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1113 bool skip = false;
1114 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001115 auto cb_node = GetCBNode(dev_data, commandBuffer);
1116 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001117 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001118 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001119 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001120 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001121 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001122 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001123 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001124 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001125 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001126 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001127 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001128 }
1129 }
1130 return skip;
1131}
1132
1133// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001134void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001135 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001136 auto cb_node = GetCBNode(dev_data, commandBuffer);
1137 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001138 if (cb_node && image_state) {
1139 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1140 std::function<bool()> function = [=]() {
1141 SetImageMemoryValid(dev_data, image_state, true);
1142 return false;
1143 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001144 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001145 for (uint32_t i = 0; i < rangeCount; ++i) {
1146 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1147 }
1148 }
1149}
1150
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001151bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1152 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001153 const VkImageSubresourceRange *pRanges) {
1154 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001155 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1156
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001157 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001158 auto cb_node = GetCBNode(device_data, commandBuffer);
1159 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001160 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001161 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001162 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001163 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001164 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001165 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001166 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001167 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001168 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001169 skip |=
1170 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001171 // Image aspect must be depth or stencil or both
1172 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1173 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1174 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001175 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1176 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001177 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 -06001178 HandleToUint64(commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001179 }
1180 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001181 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001182 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001183 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 -06001184 HandleToUint64(image), VALIDATION_ERROR_18a0001c, "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001185 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001186 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1187 char const str[] =
1188 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1189 "set.";
1190 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 -06001191 HandleToUint64(image), VALIDATION_ERROR_18a00012, "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001192 }
1193 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1194 VkImageTiling tiling = image_state->createInfo.tiling;
1195 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1196 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1197 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001198 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 -06001199 HandleToUint64(image), VALIDATION_ERROR_18a00010,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001200 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1201 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR.",
1202 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling));
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001203 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001204 }
1205 return skip;
1206}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001207
1208// Returns true if [x, xoffset] and [y, yoffset] overlap
1209static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1210 bool result = false;
1211 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1212 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1213
1214 if (intersection_max > intersection_min) {
1215 result = true;
1216 }
1217 return result;
1218}
1219
Dave Houltonc991cc92018-03-06 11:08:51 -07001220// Returns true if source area of first copy region intersects dest area of second region
1221// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1222static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001223 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001224
Dave Houltonc991cc92018-03-06 11:08:51 -07001225 // Separate planes within a multiplane image cannot intersect
1226 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001227 return result;
1228 }
1229
Dave Houltonc991cc92018-03-06 11:08:51 -07001230 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1231 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1232 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001233 result = true;
1234 switch (type) {
1235 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001236 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001237 // Intentionally fall through to 2D case
1238 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001239 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001240 // Intentionally fall through to 1D case
1241 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001242 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001243 break;
1244 default:
1245 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1246 assert(false);
1247 }
1248 }
1249 return result;
1250}
1251
Dave Houltonfc1a4052017-04-27 14:32:45 -06001252// Returns non-zero if offset and extent exceed image extents
1253static const uint32_t x_bit = 1;
1254static const uint32_t y_bit = 2;
1255static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001256static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001257 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001258 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001259 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1260 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001261 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001262 }
1263 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1264 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001265 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001266 }
1267 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1268 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001269 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001270 }
1271 return result;
1272}
1273
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001274// Test if two VkExtent3D structs are equivalent
1275static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1276 bool result = true;
1277 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1278 (extent->depth != other_extent->depth)) {
1279 result = false;
1280 }
1281 return result;
1282}
1283
Dave Houltonee281a52017-12-08 13:51:02 -07001284// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1285// Destination image texel extents must be adjusted by block size for the dest validation checks
1286VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1287 VkExtent3D adjusted_extent = extent;
1288 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1289 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1290 adjusted_extent.width /= block_size.width;
1291 adjusted_extent.height /= block_size.height;
1292 adjusted_extent.depth /= block_size.depth;
1293 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1294 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1295 adjusted_extent.width *= block_size.width;
1296 adjusted_extent.height *= block_size.height;
1297 adjusted_extent.depth *= block_size.depth;
1298 }
1299 return adjusted_extent;
1300}
1301
Dave Houlton6f9059e2017-05-02 17:15:13 -06001302// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001303static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1304 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001305
1306 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001307 if (mip >= img->createInfo.mipLevels) {
1308 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001309 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001310
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001311 // 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 -06001312 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001313 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1314 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1315 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001316
Dave Houlton6f9059e2017-05-02 17:15:13 -06001317 // Image arrays have an effective z extent that isn't diminished by mip level
1318 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001319 extent.depth = img->createInfo.arrayLayers;
1320 }
1321
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001322 return extent;
1323}
1324
1325// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001326static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001327 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1328}
1329
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001330// Test if the extent argument has any dimensions set to 0.
1331static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1332 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1333}
1334
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001335// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1336static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1337 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1338 VkExtent3D granularity = {0, 0, 0};
1339 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1340 if (pPool) {
1341 granularity =
1342 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001343 if (FormatIsCompressed(img->createInfo.format)) {
1344 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001345 granularity.width *= block_size.width;
1346 granularity.height *= block_size.height;
1347 }
1348 }
1349 return granularity;
1350}
1351
1352// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1353static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1354 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001355 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1356 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001357 valid = false;
1358 }
1359 return valid;
1360}
1361
1362// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1363static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1364 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1365 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1366 bool skip = false;
1367 VkExtent3D offset_extent = {};
1368 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1369 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1370 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001371 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001372 // 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 -07001373 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001374 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 -06001375 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001376 "%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 "
1377 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001378 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001379 }
1380 } else {
1381 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1382 // integer multiples of the image transfer granularity.
1383 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001384 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 -06001385 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001386 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1387 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001388 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1389 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001390 }
1391 }
1392 return skip;
1393}
1394
1395// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1396static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1397 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001398 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001399 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1400 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001401 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001402 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1403 // subresource extent.
1404 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001405 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 -06001406 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Petr Krausbc7f5442017-05-14 23:43:38 +02001407 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1408 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1409 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1410 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001411 }
1412 } else {
1413 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1414 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1415 // subresource extent dimensions.
1416 VkExtent3D offset_extent_sum = {};
1417 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1418 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1419 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001420 bool x_ok = true;
1421 bool y_ok = true;
1422 bool z_ok = true;
1423 switch (image_type) {
1424 case VK_IMAGE_TYPE_3D:
1425 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1426 (subresource_extent->depth == offset_extent_sum.depth));
1427 // Intentionally fall through to 2D case
1428 case VK_IMAGE_TYPE_2D:
1429 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1430 (subresource_extent->height == offset_extent_sum.height));
1431 // Intentionally fall through to 1D case
1432 case VK_IMAGE_TYPE_1D:
1433 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1434 (subresource_extent->width == offset_extent_sum.width));
1435 break;
1436 default:
1437 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1438 assert(false);
1439 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001440 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001441 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 -06001442 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_IMAGE_TRANSFER_GRANULARITY,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001443 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1444 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1445 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1446 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1447 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1448 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001449 }
1450 }
1451 return skip;
1452}
1453
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001454// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001455bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1456 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1457 const uint32_t i, const char *function) {
1458 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001459 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001460 // TODO: Add granularity checking for compressed formats
1461
1462 // bufferRowLength must be a multiple of the compressed texel block width
1463 // bufferImageHeight must be a multiple of the compressed texel block height
1464 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1465 // bufferOffset must be a multiple of the compressed texel block size in bytes
1466 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1467 // must equal the image subresource width
1468 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1469 // must equal the image subresource height
1470 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1471 // must equal the image subresource depth
1472 } else {
1473 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001474 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1475 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1476 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001477 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001478 }
1479 return skip;
1480}
1481
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001482// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001483bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001484 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1485 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001486 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001487 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001488 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001489 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001490 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001491 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001492 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001493 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001494
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001495 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001496 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001497 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001498 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001499 const VkExtent3D dest_effective_extent =
1500 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001501 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001502 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001503 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001504 return skip;
1505}
1506
Dave Houlton6f9059e2017-05-02 17:15:13 -06001507// Validate contents of a VkImageCopy struct
1508bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1509 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1510 bool skip = false;
1511
1512 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001513 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001514
1515 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001516 const VkExtent3D src_copy_extent = region.extent;
1517 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001518 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1519
Dave Houlton6f9059e2017-05-02 17:15:13 -06001520 bool slice_override = false;
1521 uint32_t depth_slices = 0;
1522
1523 // Special case for copying between a 1D/2D array and a 3D image
1524 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1525 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001526 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001527 slice_override = (depth_slices != 1);
1528 } 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 -07001529 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001530 slice_override = (depth_slices != 1);
1531 }
1532
1533 // Do all checks on source image
1534 //
1535 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001536 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1537 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 -06001538 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00124,
Dave Houltonee281a52017-12-08 13:51:02 -07001539 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001540 "be 0 and 1, respectively.",
1541 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001542 }
1543 }
1544
Dave Houlton533be9f2018-03-26 17:08:30 -06001545 // VUID-VkImageCopy-srcImage-01785
1546 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
1547 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 -06001548 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df2,
Dave Houlton533be9f2018-03-26 17:08:30 -06001549 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001550 "these must be 0 and 1, respectively.",
1551 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001552 }
1553
Dave Houlton533be9f2018-03-26 17:08:30 -06001554 // VUID-VkImageCopy-srcImage-01787
1555 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
1556 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 -06001557 HandleToUint64(src_state->image), VALIDATION_ERROR_09c00df6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001558 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
1559 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06001560 }
1561
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001562 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001563 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001564 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001565 skip |=
1566 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001567 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001568 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001569 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1570 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001571 }
1572 }
1573 } else { // Pre maint 1
1574 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001575 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001576 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001577 HandleToUint64(src_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001578 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1579 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001580 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1581 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001582 }
1583 }
1584 }
1585
Dave Houltonc991cc92018-03-06 11:08:51 -07001586 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1587 bool ext_ycbcr = GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion;
1588 if (FormatIsCompressed(src_state->createInfo.format) ||
1589 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001590 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001591 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001592 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1593 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1594 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001595 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d7e : VALIDATION_ERROR_09c0013a;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001596 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 -07001597 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001598 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001599 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001600 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001601 }
1602
Dave Houlton94a00372017-12-14 15:08:47 -07001603 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001604 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1605 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001606 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d80 : VALIDATION_ERROR_09c0013c;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001607 skip |=
1608 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001609 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001610 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001611 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001612 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001613 }
1614
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001615 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001616 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1617 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001618 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d82 : VALIDATION_ERROR_09c0013e;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001619 skip |=
1620 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001621 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001622 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001623 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001624 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001625 }
1626
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001627 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001628 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1629 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001630 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d84 : VALIDATION_ERROR_09c00140;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001631 skip |=
1632 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001633 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001634 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07001635 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001636 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001637 }
1638 } // Compressed
1639
1640 // Do all checks on dest image
1641 //
1642 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001643 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001644 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001645 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00130,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001646 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001647 "these must be 0 and 1, respectively.",
1648 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001649 }
1650 }
1651
Dave Houlton533be9f2018-03-26 17:08:30 -06001652 // VUID-VkImageCopy-dstImage-01786
1653 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
1654 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001655 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df4,
Dave Houlton533be9f2018-03-26 17:08:30 -06001656 "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 -06001657 "and 1, respectively.",
1658 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06001659 }
1660
1661 // VUID-VkImageCopy-dstImage-01788
1662 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
1663 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001664 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c00df8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001665 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
1666 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001667 }
1668
1669 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001670 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001671 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001672 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001673 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001674 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1675 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001676 }
1677 }
1678 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001679 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001680 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001681 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001682 skip |=
1683 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001684 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001685 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001686 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
1687 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001688 }
1689 }
1690 } else { // Pre maint 1
1691 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001692 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001693 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 -06001694 HandleToUint64(dst_state->image), VALIDATION_ERROR_09c0011a,
Petr Kraus13c98a62017-12-09 00:22:39 +01001695 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1696 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001697 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
1698 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001699 }
1700 }
1701 }
1702
Dave Houltonc991cc92018-03-06 11:08:51 -07001703 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
1704 if (FormatIsCompressed(dst_state->createInfo.format) ||
1705 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houlton94a00372017-12-14 15:08:47 -07001706 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001707
1708 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001709 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1710 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1711 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001712 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d86 : VALIDATION_ERROR_09c00144;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001713 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 -07001714 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001715 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07001716 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001717 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001718 }
1719
Dave Houlton94a00372017-12-14 15:08:47 -07001720 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001721 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1722 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001723 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d88 : VALIDATION_ERROR_09c00146;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001724 skip |=
1725 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001726 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001727 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001728 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001729 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001730 }
1731
Dave Houltonee281a52017-12-08 13:51:02 -07001732 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1733 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1734 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001735 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8a : VALIDATION_ERROR_09c00148;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001736 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 -07001737 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001738 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
1739 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07001740 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001741 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001742 }
1743
Dave Houltonee281a52017-12-08 13:51:02 -07001744 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1745 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1746 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Dave Houltonc991cc92018-03-06 11:08:51 -07001747 UNIQUE_VALIDATION_ERROR_CODE vuid = ext_ycbcr ? VALIDATION_ERROR_09c00d8c : VALIDATION_ERROR_09c0014a;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001748 skip |=
1749 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07001750 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001751 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07001752 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001753 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001754 }
1755 } // Compressed
1756 }
1757 return skip;
1758}
1759
Dave Houltonc991cc92018-03-06 11:08:51 -07001760// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
1761bool CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
1762 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
1763 bool skip = false;
1764 const debug_report_data *report_data = core_validation::GetReportData(dev_data);
1765
1766 // Neither image is multiplane
1767 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
1768 // If neither image is multi-plane the aspectMask member of src and dst must match
1769 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1770 std::stringstream ss;
1771 ss << "vkCmdCopyImage: Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
1772 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
1773 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1774 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c1e, "%s.", ss.str().c_str());
1775 }
1776 } else {
1777 // Source image multiplane checks
1778 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
1779 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
1780 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1781 std::stringstream ss;
1782 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1783 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1784 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c20, "%s.", ss.str().c_str());
1785 }
1786 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1787 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1788 std::stringstream ss;
1789 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1790 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1791 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c22, "%s.", ss.str().c_str());
1792 }
1793 // Single-plane to multi-plane
1794 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1795 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1796 std::stringstream ss;
1797 ss << "vkCmdCopyImage: Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1798 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1799 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c2a, "%s.", ss.str().c_str());
1800 }
1801
1802 // Dest image multiplane checks
1803 planes = FormatPlaneCount(dst_image_state->createInfo.format);
1804 aspect = region.dstSubresource.aspectMask;
1805 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
1806 std::stringstream ss;
1807 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
1808 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1809 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c24, "%s.", ss.str().c_str());
1810 }
1811 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
1812 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
1813 std::stringstream ss;
1814 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
1815 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1816 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c26, "%s.", ss.str().c_str());
1817 }
1818 // Multi-plane to single-plane
1819 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
1820 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
1821 std::stringstream ss;
1822 ss << "vkCmdCopyImage: Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
1823 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1824 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00c28, "%s.", ss.str().c_str());
1825 }
1826 }
1827
1828 return skip;
1829}
1830
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001831bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001832 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1833 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001834 bool skip = false;
1835 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001836 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1837
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001838 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1839
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001840 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001841 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001842
1843 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1844 VkExtent3D src_copy_extent = region.extent;
1845 VkExtent3D dst_copy_extent =
1846 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1847
Dave Houlton6f9059e2017-05-02 17:15:13 -06001848 bool slice_override = false;
1849 uint32_t depth_slices = 0;
1850
1851 // Special case for copying between a 1D/2D array and a 3D image
1852 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1853 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1854 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001855 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001856 slice_override = (depth_slices != 1);
1857 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1858 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001859 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001860 slice_override = (depth_slices != 1);
1861 }
1862
Dave Houltonee281a52017-12-08 13:51:02 -07001863 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001864 std::stringstream ss;
1865 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001866 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 -06001867 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001868 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001869
Dave Houltonee281a52017-12-08 13:51:02 -07001870 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001871 std::stringstream ss;
1872 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001873 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 -06001874 HandleToUint64(command_buffer), DRAWSTATE_INVALID_IMAGE_ASPECT, "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001875 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001876
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001877 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001878 // No chance of mismatch if we're overriding depth slice count
1879 if (!slice_override) {
1880 // The number of depth slices in srcSubresource and dstSubresource must match
1881 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1882 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001883 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1884 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001885 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001886 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1887 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001888 if (src_slices != dst_slices) {
1889 std::stringstream ss;
1890 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1891 << "] do not match";
1892 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 -06001893 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06001894 }
1895 }
1896 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001897 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001898 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001899 std::stringstream ss;
1900 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1901 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001902 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 -06001903 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00118, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001904 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001905 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001906
Dave Houltonc991cc92018-03-06 11:08:51 -07001907 // Do multiplane-specific checks, if extension enabled
1908 if (GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1909 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
1910 }
1911
Dave Houltonf5217612018-02-02 16:18:52 -07001912 if (!GetDeviceExtensions(device_data)->vk_khr_sampler_ycbcr_conversion) {
1913 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
1914 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
1915 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1916 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 -06001917 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00112, "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07001918 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001919 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001920
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001921 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001922 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001923 std::stringstream ss;
1924 ss << "vkCmdCopyImage: pRegion[" << i
1925 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1926 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 -06001927 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011c, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001928 }
1929
1930 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001931 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001932 std::stringstream ss;
1933 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1934 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 -06001935 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0011e, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001936 }
1937
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001938 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001939 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1940 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001941 std::stringstream ss;
1942 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1943 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 -06001944 HandleToUint64(command_buffer), VALIDATION_ERROR_0a600150, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001945 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001946
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001947 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1948 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001949 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1950 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001951 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1952 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 -06001953 HandleToUint64(command_buffer), VALIDATION_ERROR_0a60014e, "%s.", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001954 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001955
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001956 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001957 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001958 std::stringstream ss;
1959 ss << "vkCmdCopyImage: pRegions[" << i
1960 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1961 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 -06001962 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d40, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001963 }
Dave Houltonee281a52017-12-08 13:51:02 -07001964 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001965 std::stringstream ss;
1966 ss << "vkCmdCopyImage: pRegions[" << i
1967 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1968 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 -06001969 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d42, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001970 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001971
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001972 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1973 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001974 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001975 std::stringstream ss;
1976 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001977 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001978 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 -06001979 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d44, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001980 }
Dave Houltonee281a52017-12-08 13:51:02 -07001981 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001982 std::stringstream ss;
1983 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001984 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001985 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 -06001986 HandleToUint64(command_buffer), VALIDATION_ERROR_19000d46, "%s.", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001987 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001988
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001989 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1990 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1991 // 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 -07001992 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1993 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001994 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001995 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1996 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1997 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1998 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001999 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 -06002000 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f4, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002001 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002002
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002003 // 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 -07002004 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2005 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002006 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07002007 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
2008 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2009 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2010 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002011 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 -06002012 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f6, "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002013 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002014 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002015
Dave Houltonfc1a4052017-04-27 14:32:45 -06002016 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002017 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2018 if (slice_override) src_copy_extent.depth = depth_slices;
2019 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002020 if (extent_check & x_bit) {
2021 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 -06002022 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00120,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002023 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002024 "width [%1d].",
2025 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002026 }
2027
2028 if (extent_check & y_bit) {
2029 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 -06002030 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00122,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002031 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002032 "height [%1d].",
2033 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002034 }
2035 if (extent_check & z_bit) {
2036 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 -06002037 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00126,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002038 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002039 "depth [%1d].",
2040 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002041 }
2042
Dave Houltonee281a52017-12-08 13:51:02 -07002043 // Adjust dest extent if necessary
2044 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2045 if (slice_override) dst_copy_extent.depth = depth_slices;
2046
2047 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002048 if (extent_check & x_bit) {
2049 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 -06002050 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012c,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002051 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002052 "width [%1d].",
2053 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002054 }
2055 if (extent_check & y_bit) {
2056 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 -06002057 HandleToUint64(command_buffer), VALIDATION_ERROR_09c0012e,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002058 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002059 "height [%1d].",
2060 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002061 }
2062 if (extent_check & z_bit) {
2063 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 -06002064 HandleToUint64(command_buffer), VALIDATION_ERROR_09c00132,
Dave Houltonfc1a4052017-04-27 14:32:45 -06002065 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002066 "depth [%1d].",
2067 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002068 }
2069
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002070 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2071 // must not overlap in memory
2072 if (src_image_state->image == dst_image_state->image) {
2073 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonf5217612018-02-02 16:18:52 -07002074 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType,
2075 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002076 std::stringstream ss;
2077 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2078 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 -06002079 HandleToUint64(command_buffer), VALIDATION_ERROR_190000f8, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002080 }
2081 }
2082 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002083 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002084
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002085 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2086 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2087 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002088 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2090 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002091 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 -06002092 HandleToUint64(command_buffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002093 }
2094 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002095 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2096 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002097 if (srcSize != destSize) {
2098 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2099 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 -06002100 HandleToUint64(command_buffer), VALIDATION_ERROR_1900010e, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002101 }
2102 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002103
Dave Houlton33c22b72017-02-28 13:16:02 -07002104 // Source and dest image sample counts must match
2105 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2106 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2107 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 -06002108 HandleToUint64(command_buffer), VALIDATION_ERROR_19000110, "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002109 }
2110
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002111 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2112 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002114 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002115 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002116 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002117 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002118 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002119 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002120 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002121 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002122 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002123 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002124 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002125 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002126 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002127 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002128 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2129 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002130 }
2131
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002132 return skip;
2133}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002134
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002135void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002136 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2137 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2138 // Make sure that all image slices are updated to correct layout
2139 for (uint32_t i = 0; i < region_count; ++i) {
2140 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2141 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2142 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002143 // Update bindings between images and cmd buffer
2144 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2145 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002146 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002147 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002148 function = [=]() {
2149 SetImageMemoryValid(device_data, dst_image_state, true);
2150 return false;
2151 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002152 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002153}
2154
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002155// Returns true if sub_rect is entirely contained within rect
2156static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2157 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2158 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2159 return false;
2160 return true;
2161}
2162
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002163bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2164 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002165 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002166 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2167
2168 bool skip = false;
2169 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002170 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2171 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002172 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002173 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002174 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002175 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2176 // 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 -07002177 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2178 // CmdClearAttachments.
Dave Houltona9df0ce2018-02-07 10:51:23 -07002179 skip |= log_msg(
2180 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002181 HandleToUint64(commandBuffer), DRAWSTATE_CLEAR_CMD_BEFORE_DRAW,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002182 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2183 " prior to any Draw Cmds. It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2184 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002185 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002186 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002187 }
2188
2189 // Validate that attachment is in reference list of active subpass
2190 if (cb_node->activeRenderPass) {
2191 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2192 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002193 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002194
2195 for (uint32_t i = 0; i < attachmentCount; i++) {
2196 auto clear_desc = &pAttachments[i];
2197 VkImageView image_view = VK_NULL_HANDLE;
2198
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002199 if (0 == clear_desc->aspectMask) {
2200 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 -06002201 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c03, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002202 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2203 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 -06002204 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00028, " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002205 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002206 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002207 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 -06002208 HandleToUint64(commandBuffer), VALIDATION_ERROR_1860001e,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002209 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d.",
2210 clear_desc->colorAttachment, cb_node->activeSubpass);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002211 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2212 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002213 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer),
Mark Lobodzinski88529492018-04-01 10:38:15 -06002214 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002215 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2216 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002217 } else {
2218 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002219 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002220 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002221 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2222 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2223 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002224 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002225 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 -06002226 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00026, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002227 }
2228 } else { // Must be depth and/or stencil
2229 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2230 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002231 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002232 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 -06002233 HandleToUint64(commandBuffer), VALIDATION_ERROR_01c00c01, str, i);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002234 }
2235 if (!subpass_desc->pDepthStencilAttachment ||
2236 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2237 skip |= log_msg(
2238 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002239 HandleToUint64(commandBuffer), DRAWSTATE_MISSING_ATTACHMENT_REFERENCE,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002240 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002241 } else {
2242 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2243 }
2244 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002245 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002246 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002247 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002248 // The rectangular region specified by a given element of pRects must be contained within the render area of
2249 // the current render pass instance
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002250 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
2251 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2252 skip |=
2253 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 -06002254 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600020,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002255 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002256 "the current render pass instance.",
2257 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002258 }
2259 } else {
2260 cb_node->cmd_execute_commands_functions.emplace_back([=](GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2261 if (false == ContainsRect(prim_cb->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
2262 return log_msg(
2263 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(commandBuffer), VALIDATION_ERROR_18600020,
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002265 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002266 "the current render pass instance.",
2267 j);
Tobin Ehlis37ec75a2018-03-12 11:26:39 -06002268 }
2269 return false;
2270 });
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002271 }
2272 // The layers specified by a given element of pRects must be contained within every attachment that
2273 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002274 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002275 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2276 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002277 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 -06002278 HandleToUint64(commandBuffer), VALIDATION_ERROR_18600022,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002279 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002280 "of pAttachment[%d].",
2281 j, i);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002282 }
2283 }
2284 }
2285 }
2286 }
2287 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002288}
2289
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002290bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002291 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002292 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002293 bool skip = false;
2294 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002295 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2296 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2297 skip |=
2298 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002299 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002300 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002301
2302 // For each region, the number of layers in the image subresource should not be zero
2303 // For each region, src and dest image aspect must be color only
2304 for (uint32_t i = 0; i < regionCount; i++) {
2305 if (pRegions[i].srcSubresource.layerCount == 0) {
2306 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002307 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 -06002308 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002309 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002310 if (pRegions[i].dstSubresource.layerCount == 0) {
2311 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002312 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 -06002313 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002314 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002315 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2316 skip |= log_msg(
2317 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002318 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200216,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002319 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002320 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002321 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2322 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2323 char const str[] =
2324 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2325 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 -06002326 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_0a200214, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002327 }
2328 }
2329
2330 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2331 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002332 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 -06002333 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_FORMAT, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002334 }
2335 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2336 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002337 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 -06002338 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_TYPE, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002339 }
2340 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2341 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
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_1c800202, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002344 }
2345 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2346 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2347 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 -06002348 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_1c800206, "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002349 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002350 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002351 } else {
2352 assert(0);
2353 }
2354 return skip;
2355}
2356
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002357void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2358 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002359 // Update bindings between images and cmd buffer
2360 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2361 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2362
2363 std::function<bool()> function = [=]() {
2364 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2365 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002366 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002367 function = [=]() {
2368 SetImageMemoryValid(device_data, dst_image_state, true);
2369 return false;
2370 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002371 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002372}
2373
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002374bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002375 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2376 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002377 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2378
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002379 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002380 if (cb_node) {
2381 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2382 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002383 if (cb_node && src_image_state && dst_image_state) {
2384 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002385 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002386 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002387 VALIDATION_ERROR_184001d4);
2388 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2389 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2390 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2391 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2392 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2393 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2394 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002395 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002396 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002397 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002398
Dave Houlton33c2d252017-06-09 17:08:32 -06002399 VkFormat src_format = src_image_state->createInfo.format;
2400 VkFormat dst_format = dst_image_state->createInfo.format;
2401 VkImageType src_type = src_image_state->createInfo.imageType;
2402 VkImageType dst_type = dst_image_state->createInfo.imageType;
2403
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002404 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002405 VkImageTiling tiling = src_image_state->createInfo.tiling;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002406 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002407 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2408 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 -06002409 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002410 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature.",
2411 string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002412 }
2413
2414 if ((VK_FILTER_LINEAR == filter) &&
2415 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002416 skip |=
2417 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 -06002418 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002419 "vkCmdBlitImage: source image format %s does not support linear filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002420 }
2421
2422 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2423 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002424 skip |=
2425 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 -06002426 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002427 "vkCmdBlitImage: source image format %s does not support cubic filtering.", string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002428 }
2429
2430 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2431 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 -06002432 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002433 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002434 }
2435
2436 props = GetFormatProperties(device_data, dst_format);
2437 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002438 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002439 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002440 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 -06002441 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001be,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002442 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature.",
2443 string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002444 }
2445
2446 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2447 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2448 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 -06002449 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001c8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002450 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002451 }
2452
2453 // Validate consistency for unsigned formats
2454 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2455 std::stringstream ss;
2456 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2457 << "the other one must also have unsigned integer format. "
2458 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2459 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 -06002460 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001cc, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002461 }
2462
2463 // Validate consistency for signed formats
2464 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2465 std::stringstream ss;
2466 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2467 << "the other one must also have signed integer format. "
2468 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2469 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 -06002470 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ca, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002471 }
2472
2473 // Validate filter for Depth/Stencil formats
2474 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2475 std::stringstream ss;
2476 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2477 << "then filter must be VK_FILTER_NEAREST.";
2478 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 -06002479 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001d0, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002480 }
2481
2482 // Validate aspect bits and formats for depth/stencil images
2483 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2484 if (src_format != dst_format) {
2485 std::stringstream ss;
2486 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2487 << "stencil, the other one must have exactly the same format. "
2488 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2489 << string_VkFormat(dst_format);
Mark Lobodzinski88529492018-04-01 10:38:15 -06002490 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2491 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ce, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002492 }
2493
2494#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2495 for (uint32_t i = 0; i < regionCount; i++) {
2496 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2497
2498 if (FormatIsDepthAndStencil(src_format)) {
2499 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2500 std::stringstream ss;
Dave Houltona9df0ce2018-02-07 10:51:23 -07002501 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of VK_IMAGE_ASPECT_DEPTH_BIT "
Dave Houlton33c2d252017-06-09 17:08:32 -06002502 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2503 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 -06002504 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002505 "%s", ss.str().c_str());
2506 }
2507 }
2508 else if (FormatIsStencilOnly(src_format)) {
2509 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2510 std::stringstream ss;
2511 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2512 << "set in both the srcImage and dstImage";
2513 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 -06002514 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002515 "%s", ss.str().c_str());
2516 }
2517 }
2518 else if (FormatIsDepthOnly(src_format)) {
2519 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2520 std::stringstream ss;
2521 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2522 << "set in both the srcImage and dstImage";
2523 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 -06002524 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_IMAGE_ASPECT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002525 "%s", ss.str().c_str());
2526 }
2527 }
2528 }
2529#endif
2530 } // Depth or Stencil
2531
2532 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002533 for (uint32_t i = 0; i < region_count; i++) {
2534 const VkImageBlit rgn = regions[i];
2535 bool hit_error = false;
2536 skip |=
2537 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2538 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2539 skip |=
2540 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2541 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002542
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002543 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002544 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2545 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002546 std::stringstream ss;
2547 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2548 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 -06002549 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002550 }
Dave Houlton48989f32017-05-26 15:01:46 -06002551 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2552 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002553 std::stringstream ss;
2554 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2555 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 -06002556 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_INVALID_EXTENTS, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002557 }
Dave Houlton48989f32017-05-26 15:01:46 -06002558 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002559 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2560 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 -06002561 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002562 }
Dave Houlton48989f32017-05-26 15:01:46 -06002563 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002564 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2565 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 -06002566 HandleToUint64(cb_node->commandBuffer), DRAWSTATE_MISMATCHED_IMAGE_ASPECT, str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002567 }
2568
2569 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002570 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002571 skip |=
2572 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 -06002573 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001de,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002574 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002575 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002576
Dave Houlton48989f32017-05-26 15:01:46 -06002577 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002578 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 -06002579 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001dc,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002580 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002581 }
Dave Houlton48989f32017-05-26 15:01:46 -06002582
Dave Houlton33c2d252017-06-09 17:08:32 -06002583 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2584 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 -06002585 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e2,
Dave Houlton33c2d252017-06-09 17:08:32 -06002586 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002587 "image format %s.",
2588 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002589 }
2590
2591 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2592 skip |= log_msg(
2593 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002594 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e4,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002595 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.", i,
2596 rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06002597 }
2598
Dave Houlton48989f32017-05-26 15:01:46 -06002599 // Validate source image offsets
2600 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002601 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002602 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2603 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 -06002604 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ea,
Dave Houlton48989f32017-05-26 15:01:46 -06002605 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002606 "of (%1d, %1d). These must be (0, 1).",
2607 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002608 }
2609 }
2610
Dave Houlton33c2d252017-06-09 17:08:32 -06002611 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002612 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2613 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 -06002614 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ee,
Dave Houlton48989f32017-05-26 15:01:46 -06002615 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002616 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
2617 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002618 }
2619 }
2620
Dave Houlton33c2d252017-06-09 17:08:32 -06002621 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002622 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2623 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002624 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002625 skip |=
2626 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 -06002627 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002628 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
2629 i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002630 }
2631 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2632 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002633 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002634 skip |= log_msg(
2635 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_09a001e8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002637 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
2638 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002639 }
2640 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2641 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002642 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002643 skip |=
2644 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 -06002645 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001ec,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002646 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
2647 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002648 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002649 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2650 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 -06002651 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002652 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d.", i,
2653 rgn.srcSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002654 } else if (oob) {
2655 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 -06002656 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001ae,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002657 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06002658 }
Dave Houlton48989f32017-05-26 15:01:46 -06002659
2660 // Validate dest image offsets
2661 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002662 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002663 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2664 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 -06002665 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f4,
Dave Houlton48989f32017-05-26 15:01:46 -06002666 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002667 "(%1d, %1d). These must be (0, 1).",
2668 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06002669 }
2670 }
2671
Dave Houlton33c2d252017-06-09 17:08:32 -06002672 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002673 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2674 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 -06002675 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f8,
Dave Houlton48989f32017-05-26 15:01:46 -06002676 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002677 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
2678 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06002679 }
2680 }
2681
Dave Houlton33c2d252017-06-09 17:08:32 -06002682 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002683 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2684 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002685 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002686 skip |=
2687 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 -06002688 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002689 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
2690 i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06002691 }
2692 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2693 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002694 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002695 skip |= log_msg(
2696 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002697 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f2,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002698 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
2699 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06002700 }
2701 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2702 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002703 oob = true;
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002704 skip |=
2705 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 -06002706 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001f6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002707 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
2708 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06002709 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002710 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002711 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 -06002712 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002713 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d.", i,
2714 rgn.dstSubresource.mipLevel);
Dave Houlton33c2d252017-06-09 17:08:32 -06002715 } else if (oob) {
2716 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 -06002717 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_184001b0,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002718 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002719 }
2720
Dave Houlton33c2d252017-06-09 17:08:32 -06002721 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2722 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2723 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2724 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 -06002725 HandleToUint64(cb_node->commandBuffer), VALIDATION_ERROR_09a001e0,
Dave Houlton33c2d252017-06-09 17:08:32 -06002726 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002727 "layerCount other than 1.",
2728 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002729 }
2730 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002731 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002732 } else {
2733 assert(0);
2734 }
2735 return skip;
2736}
2737
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002738void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002739 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2740 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2741 // Make sure that all image slices are updated to correct layout
2742 for (uint32_t i = 0; i < region_count; ++i) {
2743 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2744 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2745 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002746 // Update bindings between images and cmd buffer
2747 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2748 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2749
2750 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002751 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002752 function = [=]() {
2753 SetImageMemoryValid(device_data, dst_image_state, true);
2754 return false;
2755 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002756 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002757}
2758
Tony Barbourdf013b92017-01-25 12:53:48 -07002759// This validates that the initial layout specified in the command buffer for
2760// the IMAGE is the same
2761// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002762bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002763 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
2764 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002765 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002766 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002767 for (auto cb_image_data : pCB->imageLayoutMap) {
2768 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002769
Dave Houltonb3f4b282018-02-22 16:25:16 -07002770 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
2771 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002772 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2773 // TODO: Set memory invalid which is in mem_tracker currently
2774 } else if (imageLayout != cb_image_data.second.initialLayout) {
2775 if (cb_image_data.first.hasSubresource) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002776 skip |= log_msg(
2777 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002778 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002779 "Cannot submit cmd buffer using image (0x%" PRIx64
2780 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], with layout %s when first use is %s.",
2781 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2782 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2783 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002784 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002785 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 -06002786 HandleToUint64(pCB->commandBuffer), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002787 "Cannot submit cmd buffer using image (0x%" PRIx64 ") with layout %s when first use is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +02002788 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2789 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002790 }
2791 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002792 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002793 }
2794 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002795 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002796}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002797
Tony Barbourdf013b92017-01-25 12:53:48 -07002798void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2799 for (auto cb_image_data : pCB->imageLayoutMap) {
2800 VkImageLayout imageLayout;
2801 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2802 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2803 }
2804}
2805
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002806// Print readable FlagBits in FlagMask
2807static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2808 std::string result;
2809 std::string separator;
2810
2811 if (accessMask == 0) {
2812 result = "[None]";
2813 } else {
2814 result = "[";
2815 for (auto i = 0; i < 32; i++) {
2816 if (accessMask & (1 << i)) {
2817 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2818 separator = " | ";
2819 }
2820 }
2821 result = result + "]";
2822 }
2823 return result;
2824}
2825
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002826// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2827// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002828// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002829static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2830 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2831 const char *type) {
2832 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2833 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002834
2835 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2836 if (accessMask & ~(required_bit | optional_bits)) {
2837 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002838 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 -06002839 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002840 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2841 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002842 }
2843 } else {
2844 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002845 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 -06002846 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002847 "%s AccessMask %d %s must contain at least one of access bits %d %s when layout is %s, unless the app "
2848 "has previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002849 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2850 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002851 } else {
2852 std::string opt_bits;
2853 if (optional_bits != 0) {
2854 std::stringstream ss;
2855 ss << optional_bits;
2856 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2857 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002858 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 -06002859 HandleToUint64(cmdBuffer), DRAWSTATE_INVALID_BARRIER,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002860 "%s AccessMask %d %s must have required access bit %d %s %s when layout is %s, unless the app has "
2861 "previously added a barrier for this transition.",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002862 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2863 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002864 }
2865 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002866 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002867}
2868
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002869// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002870// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2871// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002872bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002873 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2874 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002875 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2876 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2877 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2878 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002879 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 -06002880 VALIDATION_ERROR_12200688, "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002881 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002882 }
2883 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002884 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002885}
2886
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002887bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2888 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002889 bool skip = false;
2890
Jason Ekstranda1906302017-12-03 20:16:32 -08002891 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2892 VkFormat format = pCreateInfo->pAttachments[i].format;
2893 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2894 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2895 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002896 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 -06002897 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002898 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
2899 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2900 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2901 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002902 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07002903 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002904 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 -06002905 DRAWSTATE_INVALID_RENDERPASS,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002906 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
2907 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
2908 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
2909 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08002910 }
2911 }
2912 }
2913
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002914 // Track when we're observing the first use of an attachment
2915 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2916 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2917 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002918
2919 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2920 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2921 auto attach_index = subpass.pInputAttachments[j].attachment;
2922 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2923
2924 switch (subpass.pInputAttachments[j].layout) {
2925 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2926 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2927 // These are ideal.
2928 break;
2929
2930 case VK_IMAGE_LAYOUT_GENERAL:
2931 // May not be optimal. TODO: reconsider this warning based on other constraints.
2932 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002933 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002934 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2935 break;
2936
2937 default:
2938 // No other layouts are acceptable
2939 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 -06002940 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Cort Stratton7547f772017-05-04 15:18:52 -07002941 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2942 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2943 }
2944
2945 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2946 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2947 subpass.pDepthStencilAttachment->attachment == attach_index &&
2948 subpass.pDepthStencilAttachment->layout != layout;
2949 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2950 found_layout_mismatch =
2951 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2952 }
2953 if (found_layout_mismatch) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002954 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 -06002955 VALIDATION_ERROR_140006ae,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002956 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002957 "depth/color attachment with a different layout.",
2958 i, j, attach_index, layout);
Cort Stratton7547f772017-05-04 15:18:52 -07002959 }
2960
2961 if (attach_first_use[attach_index]) {
2962 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2963 pCreateInfo->pAttachments[attach_index]);
2964
2965 bool used_as_depth =
2966 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2967 bool used_as_color = false;
2968 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2969 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2970 }
2971 if (!used_as_depth && !used_as_color &&
2972 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2973 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002974 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002975 VALIDATION_ERROR_1400069c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002976 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
2977 attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07002978 }
2979 }
2980 attach_first_use[attach_index] = false;
2981 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002982 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2983 auto attach_index = subpass.pColorAttachments[j].attachment;
2984 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2985
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002986 // TODO: Need a way to validate shared presentable images here, currently just allowing
2987 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2988 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002989 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002990 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002991 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002992 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2993 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002994 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002995
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002996 case VK_IMAGE_LAYOUT_GENERAL:
2997 // May not be optimal; TODO: reconsider this warning based on other constraints?
2998 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06002999 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003000 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3001 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003002
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003003 default:
3004 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 -06003005 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003006 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3007 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003008 }
3009
3010 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003011 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
3012 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003013 }
3014 attach_first_use[attach_index] = false;
3015 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003016
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003017 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3018 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003019 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3020 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3021 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003022 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003023
Dave Houltona9df0ce2018-02-07 10:51:23 -07003024 case VK_IMAGE_LAYOUT_GENERAL:
3025 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3026 // doing a bunch of transitions.
3027 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003028 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003029 "GENERAL layout for depth attachment may not give optimal performance.");
3030 break;
3031
3032 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3033 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3034 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
3035 break;
3036 } else {
3037 // Intentionally fall through to generic error message
3038 }
3039
3040 default:
3041 // No other layouts are acceptable
3042 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 -06003043 DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003044 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3045 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3046 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003047 }
3048
3049 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3050 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003051 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3052 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003053 }
3054 attach_first_use[attach_index] = false;
3055 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003056 }
3057 return skip;
3058}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003059
3060// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003061bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3062 VkDeviceSize offset, VkDeviceSize end_offset) {
3063 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3064 bool skip = false;
3065 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3066 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003067 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3068 for (auto image_handle : mem_info->bound_images) {
3069 auto img_it = mem_info->bound_ranges.find(image_handle);
3070 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003071 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003072 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003073 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003074 for (auto layout : layouts) {
3075 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003076 skip |=
3077 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 -06003078 HandleToUint64(mem_info->mem), DRAWSTATE_INVALID_IMAGE_LAYOUT,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003079 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3080 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003081 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003082 }
3083 }
3084 }
3085 }
3086 }
3087 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003088 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003089}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003090
3091// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3092// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003093static 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 -06003094 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003095 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003096
3097 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003098 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003099 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003100 if (strict) {
3101 correct_usage = ((actual & desired) == desired);
3102 } else {
3103 correct_usage = ((actual & desired) != 0);
3104 }
3105 if (!correct_usage) {
3106 if (msgCode == -1) {
3107 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltona9df0ce2018-02-07 10:51:23 -07003108 skip =
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003109 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 -06003110 MEMTRACK_INVALID_USAGE_FLAG,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003111 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3112 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003113 } else {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003114 skip =
Mark Lobodzinski88529492018-04-01 10:38:15 -06003115 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 -06003116 "Invalid usage flag for %s 0x%" PRIx64 " used by %s. In this case, %s should have %s set during creation.",
3117 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003118 }
3119 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003120 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003121}
3122
3123// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3124// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003125bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003126 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003127 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3128 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003129}
3130
3131// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3132// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003133bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003134 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003135 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3136 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003137}
3138
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003139bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003140 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003141 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3142
Chris Forbese0f511c2017-06-14 12:38:01 -07003143 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003144
3145 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003146 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 -06003147 VALIDATION_ERROR_01400726,
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003148 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003149 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003150 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003151
3152 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003153 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 -06003154 VALIDATION_ERROR_01400728,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003155 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003156 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003157 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003158
3159 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003160 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 -06003161 VALIDATION_ERROR_0140072a,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003162 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003163 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003164 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003165 return skip;
3166}
3167
3168void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3169 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3170 GetBufferMap(device_data)
3171 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3172}
3173
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003174bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3175 bool skip = false;
3176 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003177 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3178 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003179 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003180 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3181 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003182 skip |= ValidateBufferUsageFlags(
3183 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 -06003184 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003185 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003186 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003187}
3188
3189void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3190 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3191}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003192
3193// For the given format verify that the aspect masks make sense
3194bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3195 const char *func_name) {
3196 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3197 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003198 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003199 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003200 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 -06003201 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003202 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003203 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003204 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 -06003205 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003206 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003207 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003208 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003209 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003210 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 -06003211 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003212 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003213 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3214 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003215 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003216 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 -06003217 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003218 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003219 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3220 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003221 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003222 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003223 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003224 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 -06003225 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003226 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003227 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003228 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 -06003229 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003230 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003231 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003232 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003233 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003234 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 -06003235 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003236 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003237 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003238 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 -06003239 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003240 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003241 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003242 } else if (FormatIsMultiplane(format)) {
3243 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3244 if (3 == FormatPlaneCount(format)) {
3245 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3246 }
3247 if ((aspect_mask & valid_flags) != aspect_mask) {
3248 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3249 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
3250 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3251 "set, where n = [0, 1, 2].",
3252 func_name);
3253 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003254 }
3255 return skip;
3256}
3257
Petr Krausffa94af2017-08-08 21:46:02 +02003258struct SubresourceRangeErrorCodes {
3259 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3260};
3261
3262bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3263 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3264 const char *image_layer_count_var_name, const uint64_t image_handle,
3265 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003266 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3267 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003268
3269 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003270 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003271 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 -06003272 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003273 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003274 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3275 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003276 }
Petr Kraus4d718682017-05-18 03:38:41 +02003277
Petr Krausffa94af2017-08-08 21:46:02 +02003278 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3279 if (subresourceRange.levelCount == 0) {
3280 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 -06003281 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003282 } else {
3283 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003284
Petr Krausffa94af2017-08-08 21:46:02 +02003285 if (necessary_mip_count > image_mip_count) {
3286 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 -06003287 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003288 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003289 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003290 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003291 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003292 }
Petr Kraus4d718682017-05-18 03:38:41 +02003293 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003294 }
Petr Kraus4d718682017-05-18 03:38:41 +02003295
3296 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003297 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003298 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 -06003299 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003300 "%s: %s.baseArrayLayer (= %" PRIu32
3301 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3302 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003303 }
Petr Kraus4d718682017-05-18 03:38:41 +02003304
Petr Krausffa94af2017-08-08 21:46:02 +02003305 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3306 if (subresourceRange.layerCount == 0) {
3307 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 -06003308 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003309 } else {
3310 const uint64_t necessary_layer_count =
3311 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003312
Petr Krausffa94af2017-08-08 21:46:02 +02003313 if (necessary_layer_count > image_layer_count) {
3314 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 -06003315 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003316 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003317 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003318 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003319 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003320 }
Petr Kraus4d718682017-05-18 03:38:41 +02003321 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003322 }
Petr Kraus4d718682017-05-18 03:38:41 +02003323
Mark Lobodzinski602de982017-02-09 11:01:33 -07003324 return skip;
3325}
3326
Petr Krausffa94af2017-08-08 21:46:02 +02003327bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3328 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3329 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3330 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3331 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3332 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3333
3334 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3335 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3336
3337 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3338 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003339 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00d6c;
Petr Krausffa94af2017-08-08 21:46:02 +02003340 subresourceRangeErrorCodes.base_layer_err =
3341 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3342 subresourceRangeErrorCodes.layer_count_err =
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003343 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00d6e;
Petr Krausffa94af2017-08-08 21:46:02 +02003344
3345 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3346 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3347 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3348}
3349
3350bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3351 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3352 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3353 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003354 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800d38;
Petr Krausffa94af2017-08-08 21:46:02 +02003355 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003356 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800d3a;
Petr Krausffa94af2017-08-08 21:46:02 +02003357
3358 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3359 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3360 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3361}
3362
3363bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3364 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3365 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3366 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003367 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00d3c;
Petr Krausffa94af2017-08-08 21:46:02 +02003368 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003369 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00d3e;
Petr Krausffa94af2017-08-08 21:46:02 +02003370
3371 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3372 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3373 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3374}
3375
3376bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3377 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3378 const char *param_name) {
3379 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3380 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003381 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000d78;
Petr Krausffa94af2017-08-08 21:46:02 +02003382 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
Mike Schuchardt8da1bb52018-02-22 10:46:31 -07003383 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000d7a;
Petr Krausffa94af2017-08-08 21:46:02 +02003384
3385 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3386 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3387 subresourceRangeErrorCodes);
3388}
3389
Mark Lobodzinski602de982017-02-09 11:01:33 -07003390bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3391 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3392 bool skip = false;
3393 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3394 if (image_state) {
3395 skip |= ValidateImageUsageFlags(
3396 device_data, image_state,
3397 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houltona9df0ce2018-02-07 10:51:23 -07003398 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003399 false, -1, "vkCreateImageView()",
3400 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3401 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003402 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003403 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003404 skip |= ValidateCreateImageViewSubresourceRange(
3405 device_data, image_state,
3406 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3407 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003408
3409 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3410 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003411 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3412 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003413 VkFormat view_format = create_info->format;
3414 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003415 VkImageType image_type = image_state->createInfo.imageType;
3416 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003417
Dave Houltonbd2e2622018-04-10 16:41:14 -06003418 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
3419 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(create_info->pNext);
3420 if (chained_ivuci_struct) {
3421 if (chained_ivuci_struct->usage & ~image_usage) {
3422 std::stringstream ss;
3423 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06003424 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06003425 << image_usage << ").";
3426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3427 VALIDATION_ERROR_3f200c66, "%s", ss.str().c_str());
3428 }
3429
3430 image_usage = chained_ivuci_struct->usage;
3431 }
3432
Mark Lobodzinski602de982017-02-09 11:01:33 -07003433 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3434 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003435 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3436 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3437 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3438 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3439 std::stringstream ss;
3440 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3441 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3442 << ") format " << string_VkFormat(image_format)
3443 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3444 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3445 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 -06003446 VALIDATION_ERROR_0ac007f4, "%s", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06003447 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003448 }
3449 } else {
3450 // Format MUST be IDENTICAL to the format the image was created with
3451 if (image_format != view_format) {
3452 std::stringstream ss;
3453 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003454 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003455 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -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_0ac007f6, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07003458 }
3459 }
3460
3461 // Validate correct image aspect bits for desired formats and format consistency
3462 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003463
3464 switch (image_type) {
3465 case VK_IMAGE_TYPE_1D:
3466 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3467 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 -06003468 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003469 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3470 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003471 }
3472 break;
3473 case VK_IMAGE_TYPE_2D:
3474 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3475 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3476 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3477 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 -06003478 VALIDATION_ERROR_0ac007d6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003479 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3480 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003481 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3482 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 -06003483 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003484 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3485 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003486 }
3487 }
3488 break;
3489 case VK_IMAGE_TYPE_3D:
3490 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3491 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3492 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3493 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003494 skip |=
3495 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 -06003496 VALIDATION_ERROR_0ac007da,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003497 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3498 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003499 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3500 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003501 skip |=
3502 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 -06003503 VALIDATION_ERROR_0ac007fa,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003504 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
3505 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003506 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
3507 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003508 }
3509 } else {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003510 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 -06003511 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003512 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3513 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003514 }
3515 }
3516 } else {
3517 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3518 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 -06003519 VALIDATION_ERROR_0ac007fa,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003520 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
3521 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06003522 }
3523 }
3524 break;
3525 default:
3526 break;
3527 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003528
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003529 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003530 bool check_tiling_features = false;
3531 VkFormatFeatureFlags tiling_features = 0;
3532 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3533 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3534 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3535 };
3536 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3537 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3538 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3539 };
3540 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3541 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003542 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003543 error_codes = linear_error_codes;
3544 check_tiling_features = true;
3545 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003546 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003547 error_codes = optimal_error_codes;
3548 check_tiling_features = true;
3549 }
3550
3551 if (check_tiling_features) {
3552 if (tiling_features == 0) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003553 skip |=
3554 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[0],
3555 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s flag set.",
3556 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003557 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003558 skip |=
3559 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[1],
3560 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3561 "VK_IMAGE_USAGE_SAMPLED_BIT flags set.",
3562 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003563 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003564 skip |=
3565 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[2],
3566 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3567 "VK_IMAGE_USAGE_STORAGE_BIT flags set.",
3568 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003569 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3570 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003571 skip |=
3572 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[3],
3573 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3574 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set.",
3575 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003576 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3577 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003578 skip |=
3579 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, error_codes[4],
3580 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the %s and "
3581 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set.",
3582 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003583 }
3584 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003585 }
3586 return skip;
3587}
3588
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003589void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3590 auto image_view_map = GetImageViewMap(device_data);
3591 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3592
3593 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003594 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003595 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3596 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003597}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003598
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003599bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3600 BUFFER_STATE *dst_buffer_state) {
3601 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003602 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3603 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003604 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003605 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3606 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3607 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3608 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003609 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003610 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003611 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003612 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003613 return skip;
3614}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003615
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003616void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3617 BUFFER_STATE *dst_buffer_state) {
3618 // Update bindings between buffers and cmd buffer
3619 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3620 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3621
3622 std::function<bool()> function = [=]() {
3623 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3624 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003625 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003626 function = [=]() {
3627 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3628 return false;
3629 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003630 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003631}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003632
3633static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3634 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3635 bool skip = false;
3636 auto buffer_state = GetBufferState(device_data, buffer);
3637 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003638 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 -06003639 DRAWSTATE_DOUBLE_DESTROY, "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
Petr Kraus13c98a62017-12-09 00:22:39 +01003640 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003641 } else {
3642 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003643 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 -06003644 HandleToUint64(buffer), VALIDATION_ERROR_23c00734,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003645 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003646 }
3647 }
3648 return skip;
3649}
3650
3651bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3652 VK_OBJECT *obj_struct) {
3653 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003654 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003655 if (GetDisables(device_data)->destroy_image_view) return false;
3656 bool skip = false;
3657 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003658 skip |=
3659 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003660 }
3661 return skip;
3662}
3663
3664void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3665 VK_OBJECT obj_struct) {
3666 // Any bound cmd buffers are now invalid
3667 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3668 (*GetImageViewMap(device_data)).erase(image_view);
3669}
3670
3671bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3672 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003673 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003674 if (GetDisables(device_data)->destroy_buffer) return false;
3675 bool skip = false;
3676 if (*buffer_state) {
3677 skip |= validateIdleBuffer(device_data, buffer);
3678 }
3679 return skip;
3680}
3681
3682void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3683 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3684 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3685 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3686 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003687 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003688 }
3689 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003690 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003691 GetBufferMap(device_data)->erase(buffer_state->buffer);
3692}
3693
3694bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3695 VK_OBJECT *obj_struct) {
3696 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003697 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003698 if (GetDisables(device_data)->destroy_buffer_view) return false;
3699 bool skip = false;
3700 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003701 skip |=
3702 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003703 }
3704 return skip;
3705}
3706
3707void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3708 VK_OBJECT obj_struct) {
3709 // Any bound cmd buffers are now invalid
3710 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3711 GetBufferViewMap(device_data)->erase(buffer_view);
3712}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003713
3714bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3715 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003716 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003717 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003718 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003719 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3720 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003721 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003722 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003723 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003724 return skip;
3725}
3726
3727void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3728 std::function<bool()> function = [=]() {
3729 SetBufferMemoryValid(device_data, buffer_state, true);
3730 return false;
3731 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003732 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003733 // Update bindings between buffer and cmd buffer
3734 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003735}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003736
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003737bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3738 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003739 bool skip = false;
3740
3741 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003742 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3743 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003744 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_0160018e,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003746 "%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 -06003747 "and 1, respectively.",
3748 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003749 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003750 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003751
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003752 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3753 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003754 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 -06003755 HandleToUint64(image_state->image), VALIDATION_ERROR_01600192,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003756 "%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 -06003757 "must be 0 and 1, respectively.",
3758 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003759 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003760 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003761
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003762 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3763 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003764 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 -06003765 HandleToUint64(image_state->image), VALIDATION_ERROR_016001aa,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003766 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
3767 "For 3D images these must be 0 and 1, respectively.",
3768 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003769 }
3770 }
3771
3772 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3773 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003774 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003775 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003776 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 -06003777 HandleToUint64(image_state->image), VALIDATION_ERROR_01600182,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003778 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003779 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER ").",
3780 function, i, pRegions[i].bufferOffset, texel_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003781 }
3782
3783 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003784 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003785 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 -06003786 HandleToUint64(image_state->image), VALIDATION_ERROR_01600184,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003787 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
3788 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003789 }
3790
3791 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3792 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003793 skip |=
3794 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003795 HandleToUint64(image_state->image), VALIDATION_ERROR_01600186,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003796 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
3797 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003798 }
3799
3800 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3801 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3802 skip |= log_msg(
3803 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003804 HandleToUint64(image_state->image), VALIDATION_ERROR_01600188,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003805 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
3806 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003807 }
3808
3809 // subresource aspectMask must have exactly 1 bit set
3810 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3811 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3812 if (aspect_mask_bits.count() != 1) {
3813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003814 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a8,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003815 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003816 }
3817
3818 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003819 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003820 skip |= log_msg(
3821 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003822 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a6,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003823 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
3824 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003825 }
3826
3827 // Checks that apply only to compressed images
3828 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3829 // reserves a place for these compressed image checks. This block of code could move there once the image
3830 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003831 if (FormatIsCompressed(image_state->createInfo.format)) {
3832 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003833
3834 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003835 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003836 skip |= log_msg(
3837 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003838 HandleToUint64(image_state->image), VALIDATION_ERROR_01600196,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003839 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
3840 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003841 }
3842
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003843 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003844 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003845 skip |= log_msg(
3846 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003847 HandleToUint64(image_state->image), VALIDATION_ERROR_01600198,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003848 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
3849 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003850 }
3851
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003852 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003853 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3854 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3855 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003856 skip |=
3857 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06003858 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019a,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003859 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3860 "width & height (%d, %d)..",
3861 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003862 }
3863
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003864 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003865 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3866 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003867 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 -06003868 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019c,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003869 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3870 ") must be a multiple of the compressed image's texel block size (" PRINTF_SIZE_T_SPECIFIER ")..",
3871 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003872 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003873
3874 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003875 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003876 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003877 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3878 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 -06003879 HandleToUint64(image_state->image), VALIDATION_ERROR_0160019e,
Dave Houlton75967fc2017-03-06 17:21:16 -07003880 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003881 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003882 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003883 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07003884 }
3885
3886 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003887 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003888 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3889 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 -06003890 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a0,
Dave Houlton75967fc2017-03-06 17:21:16 -07003891 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003892 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003893 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003894 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07003895 }
3896
3897 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003898 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003899 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3900 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 -06003901 HandleToUint64(image_state->image), VALIDATION_ERROR_016001a2,
Dave Houlton75967fc2017-03-06 17:21:16 -07003902 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003903 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07003904 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003905 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07003906 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003907 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003908 }
3909
3910 return skip;
3911}
3912
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003913static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3914 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003915 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003916 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003917
3918 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003919 VkExtent3D extent = pRegions[i].imageExtent;
3920 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003921
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003922 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3923 {
Mark Lobodzinski88529492018-04-01 10:38:15 -06003924 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3925 (uint64_t)0, IMAGE_ZERO_AREA_SUBREGION, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
3926 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003927 }
3928
3929 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3930
3931 // 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 -06003932 if (FormatIsCompressed(image_info->format)) {
3933 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003934 if (image_extent.width % block_extent.width) {
3935 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3936 }
3937 if (image_extent.height % block_extent.height) {
3938 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3939 }
3940 if (image_extent.depth % block_extent.depth) {
3941 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3942 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003943 }
3944
Dave Houltonfc1a4052017-04-27 14:32:45 -06003945 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003946 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 -06003947 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003948 }
3949 }
3950
3951 return skip;
3952}
3953
Chris Forbese8ba09a2017-06-01 17:39:02 -07003954static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003955 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3956 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003957 bool skip = false;
3958
3959 VkDeviceSize buffer_size = buff_state->createInfo.size;
3960
3961 for (uint32_t i = 0; i < regionCount; i++) {
3962 VkExtent3D copy_extent = pRegions[i].imageExtent;
3963
3964 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3965 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003966 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003967
Dave Houltonf3229d52017-02-21 15:59:08 -07003968 // Handle special buffer packing rules for specific depth/stencil formats
3969 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003970 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003971 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3972 switch (image_state->createInfo.format) {
3973 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003974 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003975 break;
3976 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003977 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003978 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003979 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003980 case VK_FORMAT_D24_UNORM_S8_UINT:
3981 unit_size = 4;
3982 break;
3983 default:
3984 break;
3985 }
3986 }
3987
Dave Houlton1d2022c2017-03-29 11:43:58 -06003988 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003989 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003990 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003991 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3992 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3993
3994 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3995 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3996 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003997 }
3998
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003999 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4000 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4001 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004002 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004003 } else {
4004 // Calculate buffer offset of final copied byte, + 1.
4005 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4006 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4007 max_buffer_offset *= unit_size; // convert to bytes
4008 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004009
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004010 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004011 skip |=
4012 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4013 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004014 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004015 }
4016 }
4017
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004018 return skip;
4019}
4020
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004021bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004022 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004023 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004024 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4025 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4026
4027 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004028 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004029
4030 // Command pool must support graphics, compute, or transfer operations
4031 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4032
4033 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4034 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4035 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 -06004036 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_19202415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004037 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004038 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004039 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004040 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004041 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004042 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004043 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004044
4045 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004046 VALIDATION_ERROR_19200178);
4047 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
4048 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004049
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004050 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004051 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004052 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004053 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4054 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
4055 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004056 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004057 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004058 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4059 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4060 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004061 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004062 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004063 }
4064 return skip;
4065}
4066
4067void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004068 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4069 VkImageLayout src_image_layout) {
4070 // Make sure that all image slices are updated to correct layout
4071 for (uint32_t i = 0; i < region_count; ++i) {
4072 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4073 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004074 // Update bindings between buffer/image and cmd buffer
4075 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004076 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004077
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004078 std::function<bool()> function = [=]() {
4079 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4080 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004081 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004082 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004083 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004084 return false;
4085 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004086 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004087}
4088
4089bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004090 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004091 const VkBufferImageCopy *pRegions, const char *func_name) {
4092 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4093 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4094
4095 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004096 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004097
4098 // Command pool must support graphics, compute, or transfer operations
4099 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4100 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4101 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4102 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 -06004103 HandleToUint64(cb_node->createInfo.commandPool), VALIDATION_ERROR_18e02415,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004104 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004105 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004106 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004107 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004108 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004109 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004110 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004111 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004112 VALIDATION_ERROR_18e00166);
4113 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4114 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4115 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4116 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4117 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004118 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004119 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004120 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004121 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004122 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4123 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4124 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004125 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4126 "vkCmdCopyBufferToImage()");
4127 }
4128 return skip;
4129}
4130
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004131void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004132 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4133 VkImageLayout dst_image_layout) {
4134 // Make sure that all image slices are updated to correct layout
4135 for (uint32_t i = 0; i < region_count; ++i) {
4136 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4137 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004138 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004139 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004140 std::function<bool()> function = [=]() {
4141 SetImageMemoryValid(device_data, dst_image_state, true);
4142 return false;
4143 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004144 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004145 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004146 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004147}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004148
4149bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4150 const auto report_data = core_validation::GetReportData(device_data);
4151 bool skip = false;
4152 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4153
Dave Houlton1d960ff2018-01-19 12:17:05 -07004154 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004155 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4156 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4157 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004158 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 -06004159 VALIDATION_ERROR_2a6007ca,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004160 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004161 }
4162
4163 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4164 if (!image_entry) {
4165 return skip;
4166 }
4167
Dave Houlton1d960ff2018-01-19 12:17:05 -07004168 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004169 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004170 skip |=
4171 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4172 VALIDATION_ERROR_2a6007c8, "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004173 }
4174
Dave Houlton1d960ff2018-01-19 12:17:05 -07004175 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004176 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004177 skip |=
4178 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4179 VALIDATION_ERROR_2a600d68, "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.",
4180 pSubresource->mipLevel, image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004181 }
4182
Dave Houlton1d960ff2018-01-19 12:17:05 -07004183 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004184 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004185 skip |=
4186 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4187 VALIDATION_ERROR_2a600d6a, "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4188 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004189 }
4190
Dave Houlton1d960ff2018-01-19 12:17:05 -07004191 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004192 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004193 if (FormatIsMultiplane(img_format)) {
4194 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4195 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4196 if (FormatPlaneCount(img_format) > 2u) {
4197 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4198 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4199 }
4200 if (sub_aspect != (sub_aspect & allowed_flags)) {
4201 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 -06004202 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004203 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004204 ") must be a single-plane specifier flag.",
4205 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004206 }
4207 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004208 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004209 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004210 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Mark Lobodzinski88529492018-04-01 10:38:15 -06004211 VALIDATION_ERROR_0a400c01,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004212 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004213 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004214 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004215 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004216 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 -06004217 HandleToUint64(image), VALIDATION_ERROR_0a400c01,
Mike Weiblen672b58b2017-02-21 14:32:53 -07004218 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004219 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004220 }
4221 }
4222 return skip;
4223}