blob: 2cecf87cf97534fb9de599d7e38ba5e295660a75 [file] [log] [blame]
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07001/* Copyright (c) 2015-2017 The Khronos Group Inc.
2 * Copyright (c) 2015-2017 Valve Corporation
3 * Copyright (c) 2015-2017 LunarG, Inc.
4 * Copyright (C) 2015-2017 Google Inc.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070020 */
21
22// Allow use of STL min and max functions in Windows
23#define NOMINMAX
24
Petr Kraus4d718682017-05-18 03:38:41 +020025#include <inttypes.h>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070026#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020027#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070028
29#include "vk_enum_string_helper.h"
30#include "vk_layer_data.h"
31#include "vk_layer_utils.h"
32#include "vk_layer_logging.h"
33
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070034#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070035
Tobin Ehlis58c884f2017-02-08 12:15:27 -070036void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Chris Forbes4eab4b02017-04-26 10:21:20 -070037 if (pCB->imageLayoutMap.find(imgpair) != pCB->imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070038 pCB->imageLayoutMap[imgpair].layout = layout;
39 } else {
40 assert(imgpair.hasSubresource);
41 IMAGE_CMD_BUF_LAYOUT_NODE node;
42 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
43 node.initialLayout = layout;
44 }
45 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
46 }
47}
48template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070049void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070050 ImageSubresourcePair imgpair = {image, true, range};
51 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
53 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
54 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
55}
56
57template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070058void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070059 VkImageAspectFlags aspectMask) {
60 if (imgpair.subresource.aspectMask & aspectMask) {
61 imgpair.subresource.aspectMask = aspectMask;
62 SetLayout(device_data, pObject, imgpair, layout);
63 }
64}
65
Tony Barbourdf013b92017-01-25 12:53:48 -070066// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070067void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
68 VkImageLayout layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -070069 imageLayoutMap[imgpair].layout = layout;
70}
71
Tobin Ehlisc8266452017-04-07 12:20:30 -060072bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070073 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
74 const debug_report_data *report_data = core_validation::GetReportData(device_data);
75
76 if (!(imgpair.subresource.aspectMask & aspectMask)) {
77 return false;
78 }
79 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
80 imgpair.subresource.aspectMask = aspectMask;
81 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
82 if (imgsubIt == pCB->imageLayoutMap.end()) {
83 return false;
84 }
85 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020086 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
87 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070088 "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 +020089 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070090 string_VkImageLayout(imgsubIt->second.layout));
91 }
92 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020093 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
94 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070095 "Cannot query for VkImage 0x%" PRIx64
96 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +020097 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070098 string_VkImageLayout(imgsubIt->second.initialLayout));
99 }
100 node = imgsubIt->second;
101 return true;
102}
103
Tobin Ehlisc8266452017-04-07 12:20:30 -0600104bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700105 const VkImageAspectFlags aspectMask) {
106 if (!(imgpair.subresource.aspectMask & aspectMask)) {
107 return false;
108 }
109 const debug_report_data *report_data = core_validation::GetReportData(device_data);
110 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
111 imgpair.subresource.aspectMask = aspectMask;
112 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
113 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
114 return false;
115 }
116 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200117 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
118 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700119 "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 +0200120 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700121 string_VkImageLayout(imgsubIt->second.layout));
122 }
123 layout = imgsubIt->second.layout;
124 return true;
125}
126
127// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600128bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700129 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
130 ImageSubresourcePair imgpair = {image, true, range};
131 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
132 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
133 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
134 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
135 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
136 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
137 imgpair = {image, false, VkImageSubresource()};
138 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
139 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
140 // TODO: This is ostensibly a find function but it changes state here
141 node = imgsubIt->second;
142 }
143 return true;
144}
145
146// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700147bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700148 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
149 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
150 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
151 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
152 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
153 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
154 imgpair = {imgpair.image, false, VkImageSubresource()};
155 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
156 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
157 layout = imgsubIt->second.layout;
158 }
159 return true;
160}
161
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700162bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700163 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
164 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700165 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700166 if (!image_state) return false;
167 bool ignoreGlobal = false;
168 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
169 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
170 ignoreGlobal = true;
171 }
172 for (auto imgsubpair : sub_data->second) {
173 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
174 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
175 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
176 layouts.push_back(img_data->second.layout);
177 }
178 }
179 return true;
180}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700181bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
182 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700183 if (!(imgpair.subresource.aspectMask & aspectMask)) {
184 return false;
185 }
186 imgpair.subresource.aspectMask = aspectMask;
187 auto imgsubIt = imageLayoutMap.find(imgpair);
188 if (imgsubIt == imageLayoutMap.end()) {
189 return false;
190 }
191 layout = imgsubIt->second.layout;
192 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700193}
Tony Barbourdf013b92017-01-25 12:53:48 -0700194
195// find layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -0700196bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
197 VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700198 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
199 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
200 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
201 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
202 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
203 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
204 imgpair = {imgpair.image, false, VkImageSubresource()};
205 auto imgsubIt = imageLayoutMap.find(imgpair);
206 if (imgsubIt == imageLayoutMap.end()) return false;
207 layout = imgsubIt->second.layout;
208 }
209 return true;
210}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700211
212// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700213void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700214 VkImage &image = imgpair.image;
215 (*core_validation::GetImageLayoutMap(device_data))[imgpair].layout = layout;
216 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
217 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
218 if (subresource == image_subresources.end()) {
219 image_subresources.push_back(imgpair);
220 }
221}
222
223// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700224void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700225 pCB->imageLayoutMap[imgpair] = node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700226}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600227// Set image layout for given VkImageSubresourceRange struct
228void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
229 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
230 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700231 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600232 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
233 uint32_t level = image_subresource_range.baseMipLevel + level_index;
234 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
235 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
236 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700237 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
238 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600239 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600240 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700241 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
242 }
243 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600244 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700245 }
246 }
247}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600248// Set image layout for given VkImageSubresourceLayers struct
249void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
250 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
251 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
252 VkImageSubresourceRange image_subresource_range;
253 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
254 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
255 image_subresource_range.layerCount = image_subresource_layers.layerCount;
256 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
257 image_subresource_range.levelCount = 1;
258 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
259}
260// Set image layout for all slices of an image view
261void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
262 auto view_state = GetImageViewState(device_data, imageView);
263 assert(view_state);
264
265 SetImageLayout(device_data, cb_node, GetImageState(device_data, view_state->create_info.image),
266 view_state->create_info.subresourceRange, layout);
267}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700268
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700269bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700270 const VkRenderPassBeginInfo *pRenderPassBegin,
271 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600272 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700273 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700274 auto const &framebufferInfo = framebuffer_state->createInfo;
275 const auto report_data = core_validation::GetReportData(device_data);
276 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600277 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200278 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600279 "You cannot start a render pass using a framebuffer "
280 "with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700281 }
282 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
283 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700284 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700285 assert(view_state);
286 const VkImage &image = view_state->create_info.image;
287 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700288 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700289 // TODO: Do not iterate over every possibility - consolidate where possible
290 for (uint32_t j = 0; j < subRange.levelCount; j++) {
291 uint32_t level = subRange.baseMipLevel + j;
292 for (uint32_t k = 0; k < subRange.layerCount; k++) {
293 uint32_t layer = subRange.baseArrayLayer + k;
294 VkImageSubresource sub = {subRange.aspectMask, level, layer};
295 IMAGE_CMD_BUF_LAYOUT_NODE node;
296 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700297 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700298 continue;
299 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700300 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600301 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
302 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
303 "You cannot start a render pass using attachment %u "
304 "where the render pass initial layout is %s and the previous "
305 "known layout of the attachment is %s. The layouts must match, or "
306 "the render pass initial layout for the attachment must be "
307 "VK_IMAGE_LAYOUT_UNDEFINED",
308 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700309 }
310 }
311 }
312 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600313 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700314}
315
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700316void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700317 VkAttachmentReference ref) {
318 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
319 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
320 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
321 }
322}
323
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700324void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700325 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700326 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700327
328 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700329 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700330 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
331 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
332 }
333 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
334 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
335 }
336 if (subpass.pDepthStencilAttachment) {
337 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
338 }
339 }
340}
341
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600342bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700343 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700344 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
345 return false;
346 }
347 VkImageSubresource sub = {aspect, level, layer};
348 IMAGE_CMD_BUF_LAYOUT_NODE node;
349 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700350 return false;
351 }
352 bool skip = false;
353 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
354 // TODO: Set memory invalid which is in mem_tracker currently
355 } else if (node.layout != mem_barrier->oldLayout) {
Petr Kraus13c98a62017-12-09 00:22:39 +0100356 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
357 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer), __LINE__,
358 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
359 "For image 0x%" PRIx64 " you cannot transition the layout of aspect %d from %s when current layout is %s.",
360 HandleToUint64(mem_barrier->image), aspect, string_VkImageLayout(mem_barrier->oldLayout),
361 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700362 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700363 return skip;
364}
365
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700366// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
367// 1. Transition into initialLayout state
368// 2. Transition from initialLayout to layout used in subpass 0
369void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
370 FRAMEBUFFER_STATE *framebuffer_state) {
371 // First transition into initialLayout
372 auto const rpci = render_pass_state->createInfo.ptr();
373 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
374 VkImageView image_view = framebuffer_state->createInfo.pAttachments[i];
375 SetImageViewLayout(device_data, cb_state, image_view, rpci->pAttachments[i].initialLayout);
376 }
377 // Now transition for first subpass (index 0)
378 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
379}
380
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700381void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
382 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
383 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
384 return;
385 }
386 VkImageSubresource sub = {aspect, level, layer};
387 IMAGE_CMD_BUF_LAYOUT_NODE node;
388 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700389 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700390 SetLayout(device_data, pCB, mem_barrier->image, sub,
391 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
392 return;
393 }
394 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
395 // TODO: Set memory invalid
396 }
397 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
398}
399
Dave Houlton10b39482017-03-16 13:18:15 -0600400bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600401 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600402 if (!FormatIsColor(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600403 }
404 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600405 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600406 }
407 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600408 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600409 }
410 return true;
411}
412
Mike Weiblen62d08a32017-03-07 22:18:27 -0700413// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
414bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
415 VkImageUsageFlags usage_flags, const char *func_name) {
416 const auto report_data = core_validation::GetReportData(device_data);
417 bool skip = false;
418 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
419 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
420
421 switch (layout) {
422 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
423 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600424 msg_code = VALIDATION_ERROR_0a000970;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700425 }
426 break;
427 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
428 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600429 msg_code = VALIDATION_ERROR_0a000972;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700430 }
431 break;
432 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
433 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600434 msg_code = VALIDATION_ERROR_0a000974;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700435 }
436 break;
437 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
438 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600439 msg_code = VALIDATION_ERROR_0a000976;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700440 }
441 break;
442 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
443 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600444 msg_code = VALIDATION_ERROR_0a000978;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700445 }
446 break;
447 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
448 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600449 msg_code = VALIDATION_ERROR_0a00097a;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700450 }
451 break;
452 default:
453 // Other VkImageLayout values do not have VUs defined in this context.
454 break;
455 }
456
457 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600458 skip |=
459 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200460 HandleToUint64(img_barrier->image), __LINE__, msg_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600461 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ". %s",
Petr Kraus13c98a62017-12-09 00:22:39 +0100462 func_name, static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"),
463 string_VkImageLayout(layout), HandleToUint64(img_barrier->image), usage_flags, validation_error_map[msg_code]);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700464 }
465 return skip;
466}
467
468// Verify image barriers are compatible with the images they reference.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600469bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700470 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700471 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700472
Mike Weiblen62d08a32017-03-07 22:18:27 -0700473 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
474 auto img_barrier = &pImageMemoryBarriers[i];
475 if (!img_barrier) continue;
476
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600477 auto image_state = GetImageState(device_data, img_barrier->image);
478 if (image_state) {
479 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
480 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
481 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
482
483 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
484 if (image_state->layout_locked) {
485 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600486 skip |= log_msg(
487 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600488 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, 0, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100489 "Attempting to transition shared presentable image 0x%" PRIx64
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600490 " 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 +0100491 HandleToUint64(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600492 string_VkImageLayout(img_barrier->newLayout));
493 }
494 }
495
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600496 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600497 // For a Depth/Stencil image both aspects MUST be set
498 if (FormatIsDepthAndStencil(image_create_info->format)) {
499 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
500 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
501 if ((aspect_mask & ds_mask) != (ds_mask)) {
Petr Kraus13c98a62017-12-09 00:22:39 +0100502 skip |= log_msg(
503 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
504 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), __LINE__, VALIDATION_ERROR_0a00096e,
505 "DS", "%s: Image barrier 0x%p references image 0x%" PRIx64
506 " of format %s that must have the depth and stencil aspects set, but its "
507 "aspectMask is 0x%" PRIx32 ". %s",
508 func_name, static_cast<const void *>(img_barrier), HandleToUint64(img_barrier->image),
509 string_VkFormat(image_create_info->format), aspect_mask, validation_error_map[VALIDATION_ERROR_0a00096e]);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600510 }
511 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600512 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
513 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700514
Mike Weiblen62d08a32017-03-07 22:18:27 -0700515 for (uint32_t j = 0; j < level_count; j++) {
516 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
517 for (uint32_t k = 0; k < layer_count; k++) {
518 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600519 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
520 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
521 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
522 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700523 }
524 }
525 }
526 return skip;
527}
528
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700529void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
530 const VkImageMemoryBarrier *pImgMemBarriers) {
531 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700532
533 for (uint32_t i = 0; i < memBarrierCount; ++i) {
534 auto mem_barrier = &pImgMemBarriers[i];
535 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700536
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600537 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
538 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
539 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
540
541 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700542 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600543 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700544 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
545 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
546 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
547 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
548 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
549 }
550 }
551 }
552}
553
Tobin Ehlisc8266452017-04-07 12:20:30 -0600554bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600555 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600556 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700557 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600558 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600559 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700560
561 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
562 uint32_t layer = i + subLayers.baseArrayLayer;
563 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
564 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600565 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
566 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600567 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600568 // TODO: Improve log message in the next pass
Petr Kraus13c98a62017-12-09 00:22:39 +0100569 skip |= log_msg(
570 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
571 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
572 "%s: Cannot use image 0x%" PRIx64 " with specific layout %s that doesn't match the actual current layout %s.",
573 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600574 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 }
576 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600577 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
578 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
579 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700580 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
581 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600582 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200583 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer), __LINE__,
584 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100585 "%s: For optimal performance image 0x%" PRIx64 " layout should be %s instead of GENERAL.", caller,
586 HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700587 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600588 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600589 if (image_state->shared_presentable) {
590 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
591 // TODO: Add unique error id when available.
592 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
593 __LINE__, msg_code, "DS",
594 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
595 string_VkImageLayout(optimal_layout));
596 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600597 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700598 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600599 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600600 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200601 HandleToUint64(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +0100602 "%s: Layout for image 0x%" PRIx64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s", caller,
603 HandleToUint64(image), string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout),
604 validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700605 }
606 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600607 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700608}
609
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700610void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
611 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700612 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 if (!renderPass) return;
614
615 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
616 if (framebuffer_state) {
617 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
618 auto image_view = framebuffer_state->createInfo.pAttachments[i];
619 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
620 }
621 }
622}
Dave Houlton130c0212018-01-29 13:39:56 -0700623
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700624bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700625 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600626 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700627 const debug_report_data *report_data = core_validation::GetReportData(device_data);
628
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600629 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600630 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600631 VALIDATION_ERROR_09e0075e, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
632 validation_error_map[VALIDATION_ERROR_09e0075e]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600633
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600634 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600635 }
636
Dave Houlton130c0212018-01-29 13:39:56 -0700637 bool optimal_tiling = (VK_IMAGE_TILING_OPTIMAL == pCreateInfo->tiling);
638 const char *tiling_string = string_VkImageTiling(pCreateInfo->tiling);
639 const char *format_string = string_VkFormat(pCreateInfo->format);
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600640 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Dave Houlton130c0212018-01-29 13:39:56 -0700641 VkFormatFeatureFlags features = (optimal_tiling ? properties.optimalTilingFeatures : properties.linearTilingFeatures);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600642
Dave Houlton130c0212018-01-29 13:39:56 -0700643 if (0 == features) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600644 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700645 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ac : VALIDATION_ERROR_09e007a2);
646 ss << "vkCreateImage format parameter " << format_string << " is an unsupported format";
647 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
648 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600649 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600650 }
651
Dave Houlton130c0212018-01-29 13:39:56 -0700652 if ((pCreateInfo->usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600653 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700654 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007ae : VALIDATION_ERROR_09e007a4);
655 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_SAMPLED_BIT is not supported for format " << format_string << " with tiling "
656 << tiling_string;
657 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
658 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
659 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600660
Dave Houlton130c0212018-01-29 13:39:56 -0700661 if ((pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
662 std::stringstream ss;
663 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b0 : VALIDATION_ERROR_09e007a6);
664 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_STORAGE_BIT is not supported for format " << format_string << " with tiling "
665 << tiling_string;
666 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
667 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600668 }
669
Lenny Komowb79f04a2017-09-18 17:07:00 -0600670 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
671 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
672 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
673 // Validate that format supports usage as color attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700674 if ((pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
675 (0 == (features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))) {
676 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b2 : VALIDATION_ERROR_09e007a8);
677 std::stringstream ss;
678 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_COLOR_ATTACHMENT is not supported for format " << format_string
679 << " with tiling " << tiling_string;
680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
681 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600682 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600683
Lenny Komowb79f04a2017-09-18 17:07:00 -0600684 // Validate that format supports usage as depth/stencil attachment
Dave Houlton130c0212018-01-29 13:39:56 -0700685 if ((pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
686 (0 == (features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
687 UNIQUE_VALIDATION_ERROR_CODE vuid = (optimal_tiling ? VALIDATION_ERROR_09e007b4 : VALIDATION_ERROR_09e007aa);
688 std::stringstream ss;
689 ss << "vkCreateImage: usage bit VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT is not supported for format " << format_string
690 << " with tiling " << tiling_string;
691 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, vuid,
692 "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[vuid]);
693 }
694 }
695
696 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
697 std::stringstream ss;
698 ss << "vkCreateImage: Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set";
699 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
700 VALIDATION_ERROR_09e0076a, "IMAGE", "%s. %s", ss.str().c_str(),
701 validation_error_map[VALIDATION_ERROR_09e0076a]);
702 }
703
704 const VkPhysicalDeviceLimits *device_limits = &(GetPhysicalDeviceProperties(device_data)->limits);
705 VkImageFormatProperties format_limits; // Format limits may exceed general device limits
706 VkResult err = GetImageFormatProperties(device_data, pCreateInfo, &format_limits);
707 if (VK_SUCCESS != err) {
708 std::stringstream ss;
709 ss << "vkCreateImage: The combination of format, type, tiling, usage and flags supplied in the VkImageCreateInfo struct is "
710 "reported by vkGetPhysicalDeviceImageFormatProperties() as unsupported";
711 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
712 VALIDATION_ERROR_09e00758, "IMAGE", "%s. %s", ss.str().c_str(),
713 validation_error_map[VALIDATION_ERROR_09e00758]);
714 return skip;
715 }
716
717 if ((VK_IMAGE_TYPE_1D == pCreateInfo->imageType) &&
718 (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension1D, format_limits.maxExtent.width))) {
719 std::stringstream ss;
720 ss << "vkCreateImage: 1D image width exceeds maximum supported width for format " << format_string;
721 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
722 VALIDATION_ERROR_09e0076e, "IMAGE", "%s. %s", ss.str().c_str(),
723 validation_error_map[VALIDATION_ERROR_09e0076e]);
724 }
725
726 if (VK_IMAGE_TYPE_2D == pCreateInfo->imageType) {
727 if (0 == (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
728 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.width) ||
729 pCreateInfo->extent.height > std::max(device_limits->maxImageDimension2D, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600730 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700731 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for format " << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600732 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700733 VALIDATION_ERROR_09e00770, "IMAGE", "%s. %s", ss.str().c_str(),
734 validation_error_map[VALIDATION_ERROR_09e00770]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600735 }
Dave Houlton130c0212018-01-29 13:39:56 -0700736 } else {
737 if (pCreateInfo->extent.width > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.width) ||
738 pCreateInfo->extent.height > std::max(device_limits->maxImageDimensionCube, format_limits.maxExtent.height)) {
Lenny Komowb79f04a2017-09-18 17:07:00 -0600739 std::stringstream ss;
Dave Houlton130c0212018-01-29 13:39:56 -0700740 ss << "vkCreateImage: 2D image extent exceeds maximum supported width or height for cube-compatible images with "
741 "format "
742 << format_string;
Lenny Komowb79f04a2017-09-18 17:07:00 -0600743 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700744 VALIDATION_ERROR_09e00772, "IMAGE", "%s. %s", ss.str().c_str(),
745 validation_error_map[VALIDATION_ERROR_09e00772]);
Lenny Komowb79f04a2017-09-18 17:07:00 -0600746 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600747 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700748 }
749
Dave Houlton130c0212018-01-29 13:39:56 -0700750 if (VK_IMAGE_TYPE_3D == pCreateInfo->imageType) {
751 if ((pCreateInfo->extent.width > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.width)) ||
752 (pCreateInfo->extent.height > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.height)) ||
753 (pCreateInfo->extent.depth > std::max(device_limits->maxImageDimension3D, format_limits.maxExtent.depth))) {
754 std::stringstream ss;
755 ss << "vkCreateImage: 3D image extent exceeds maximum supported width, height, or depth for format " << format_string;
756 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
757 VALIDATION_ERROR_09e00776, "IMAGE", "%s. %s", ss.str().c_str(),
758 validation_error_map[VALIDATION_ERROR_09e00776]);
759 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700760 }
761
Dave Houlton130c0212018-01-29 13:39:56 -0700762 // NOTE: As of 1/30/2018 the spec VU language is as in the commented code below. I believe this is an
763 // error in the spec, and have submitted Gitlab Vulkan issue #1151 to have it changed to match the
764 // implementation shown. DJH
765 //
766 // if ((pCreateInfo->mipLevels > format_limits.maxMipLevels) &&
767 // (std::max({ pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth }) >
768 // device_limits->maxImageDimension3D)) {
769 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
770 std::stringstream ss;
771 ss << "vkCreateImage: Image mip levels exceed image format maxMipLevels for format " << format_string;
772 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
773 VALIDATION_ERROR_09e0077e, "IMAGE", "%s. %s", ss.str().c_str(),
774 validation_error_map[VALIDATION_ERROR_09e0077e]);
775 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700776
Dave Houlton130c0212018-01-29 13:39:56 -0700777 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
778 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
779 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
780 std::stringstream ss;
781 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image width exceeds device "
782 "maxFramebufferWidth";
783 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
784 VALIDATION_ERROR_09e00788, "IMAGE", "%s. %s", ss.str().c_str(),
785 validation_error_map[VALIDATION_ERROR_09e00788]);
786 }
787
788 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
789 std::stringstream ss;
790 ss << "vkCreateImage: Image usage flags include a frame buffer attachment bit and image height exceeds device "
791 "maxFramebufferHeight";
792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
793 VALIDATION_ERROR_09e0078a, "IMAGE", "%s. %s", ss.str().c_str(),
794 validation_error_map[VALIDATION_ERROR_09e0078a]);
795 }
796
797 uint64_t total_size = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
798 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
799 (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format);
800
801 // Round up to imageGranularity boundary
802 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
803 uint64_t ig_mask = imageGranularity - 1;
804 total_size = (total_size + ig_mask) & ~ig_mask;
805
806 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
808 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
809 "CreateImage resource size exceeds allowable maximum "
810 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Dave Houlton130c0212018-01-29 13:39:56 -0700811 total_size, format_limits.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700812 }
813
Dave Houlton130c0212018-01-29 13:39:56 -0700814 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600815 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
Dave Houlton130c0212018-01-29 13:39:56 -0700816 VALIDATION_ERROR_09e00780, "Image",
817 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
818 pCreateInfo->arrayLayers, format_limits.maxArrayLayers, validation_error_map[VALIDATION_ERROR_09e00780]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700819 }
820
Dave Houlton130c0212018-01-29 13:39:56 -0700821 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600822 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600823 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Dave Houlton130c0212018-01-29 13:39:56 -0700824 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600825 validation_error_map[VALIDATION_ERROR_09e0078e]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700826 }
827
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600828 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600829 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600830 VALIDATION_ERROR_09e00792, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600831 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
832 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600833 validation_error_map[VALIDATION_ERROR_09e00792]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600834 }
835
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600836 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600837 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
838 DRAWSTATE_INVALID_FEATURE, "DS",
839 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
840 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600841 }
842
Lenny Komowb79f04a2017-09-18 17:07:00 -0600843 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
844 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
845 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
846 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
847 // TODO: Add Maintenance2 VUID
848 skip |=
849 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
850 VALIDATION_ERROR_UNDEFINED, "DS",
851 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
852 "format must be block, ETC or ASTC compressed, but is %s",
853 string_VkFormat(pCreateInfo->format));
854 }
855 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
856 // TODO: Add Maintenance2 VUID
857 skip |=
858 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
859 VALIDATION_ERROR_UNDEFINED, "DS",
860 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
861 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
862 }
863 }
864 }
865
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600866 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700867}
868
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700869void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700870 IMAGE_LAYOUT_NODE image_state;
871 image_state.layout = pCreateInfo->initialLayout;
872 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700873 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 -0700874 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700875 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
876 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700877}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700878
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700879bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700880 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700881 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200882 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700883 if (disabled->destroy_image) return false;
884 bool skip = false;
885 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600886 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
887 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700888 }
889 return skip;
890}
891
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700892void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700893 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
894 // Clean up memory mapping, bindings and range references for image
895 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700896 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700897 if (mem_info) {
898 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
899 }
900 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600901 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700902 // Remove image from imageMap
903 core_validation::GetImageMap(device_data)->erase(image);
904 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
905 core_validation::GetImageSubresourceMap(device_data);
906
907 const auto &sub_entry = imageSubresourceMap->find(image);
908 if (sub_entry != imageSubresourceMap->end()) {
909 for (const auto &pair : sub_entry->second) {
910 core_validation::GetImageLayoutMap(device_data)->erase(pair);
911 }
912 imageSubresourceMap->erase(sub_entry);
913 }
914}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700915
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700916bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700917 bool skip = false;
918 const debug_report_data *report_data = core_validation::GetReportData(device_data);
919
920 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
921 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
922 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200923 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700924 }
925
Dave Houlton1d2022c2017-03-29 11:43:58 -0600926 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700927 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600929 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
930 validation_error_map[VALIDATION_ERROR_1880000e]);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600931 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700932 char const str[] = "vkCmdClearColorImage called with compressed image.";
933 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600934 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
935 validation_error_map[VALIDATION_ERROR_1880000e]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700936 }
937
938 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
939 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
940 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600941 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s. %s", str,
942 validation_error_map[VALIDATION_ERROR_18800004]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700943 }
944 return skip;
945}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700946
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600947uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
948 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
949 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700950 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600951 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700952 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600953 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700954}
955
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600956uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
957 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
958 uint32_t array_layer_count = range->layerCount;
959 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
960 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700961 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600962 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700963}
964
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700965bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700966 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
967 bool skip = false;
968 const debug_report_data *report_data = core_validation::GetReportData(device_data);
969
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600970 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
971 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700972
973 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
974 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700975 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
976 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600977 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200978 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700979 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
980 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600981 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600982 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600983 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600984 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton33c2d252017-06-09 17:08:32 -0600985 HandleToUint64(image_state->image), __LINE__, 0, "DS",
986 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
987 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600988
989 } else {
990 if (image_state->shared_presentable) {
991 skip |= log_msg(
992 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600993 HandleToUint64(image_state->image), __LINE__, 0, "DS",
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600994 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
995 string_VkImageLayout(dest_image_layout));
996 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600997 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700998 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600999 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001000 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001001 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001002 } else {
1003 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1004 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001005 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001006 HandleToUint64(image_state->image), __LINE__, error_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001007 "%s: Layout for cleared image is %s but can only be "
1008 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
1009 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001010 }
1011 }
1012
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001013 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1014 uint32_t level = level_index + range.baseMipLevel;
1015 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1016 uint32_t layer = layer_index + range.baseArrayLayer;
1017 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001018 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001019 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001020 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001021 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001022 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001023 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001024 } else {
1025 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1026 }
1027 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1028 __LINE__, error_code, "DS",
1029 "%s: Cannot clear an image whose layout is %s and "
1030 "doesn't match the current layout %s. %s",
1031 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
1032 validation_error_map[error_code]);
1033 }
1034 }
1035 }
1036 }
1037
1038 return skip;
1039}
1040
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001041void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1042 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001043 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1044 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1045 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001046
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001047 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1048 uint32_t level = level_index + range.baseMipLevel;
1049 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1050 uint32_t layer = layer_index + range.baseArrayLayer;
1051 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001052 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001053 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1054 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 -07001055 }
1056 }
1057 }
1058}
1059
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001060bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001061 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1062 bool skip = false;
1063 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001064 auto cb_node = GetCBNode(dev_data, commandBuffer);
1065 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001066 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001067 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001068 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001069 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001070 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001071 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001072 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001073 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001074 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001075 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001076 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001077 }
1078 }
1079 return skip;
1080}
1081
1082// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001083void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001084 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001085 auto cb_node = GetCBNode(dev_data, commandBuffer);
1086 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001087 if (cb_node && image_state) {
1088 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1089 std::function<bool()> function = [=]() {
1090 SetImageMemoryValid(dev_data, image_state, true);
1091 return false;
1092 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001093 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001094 for (uint32_t i = 0; i < rangeCount; ++i) {
1095 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1096 }
1097 }
1098}
1099
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001100bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1101 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001102 const VkImageSubresourceRange *pRanges) {
1103 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001104 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1105
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001106 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001107 auto cb_node = GetCBNode(device_data, commandBuffer);
1108 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001109 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001110 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001111 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001112 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001113 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001114 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001115 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001116 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001117 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001118 skip |=
1119 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001120 // Image aspect must be depth or stencil or both
1121 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1122 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1123 char const str[] =
1124 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
1125 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
1126 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001127 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001128 }
1129 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001130 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001131 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001132 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1133 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s. %s", str,
1134 validation_error_map[VALIDATION_ERROR_18a0001c]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001135 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001136 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1137 char const str[] =
1138 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1139 "set.";
1140 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1141 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00012, "IMAGE", "%s. %s", str,
1142 validation_error_map[VALIDATION_ERROR_18a00012]);
1143 }
1144 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1145 VkImageTiling tiling = image_state->createInfo.tiling;
1146 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1147 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1148 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
1149 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1150 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00010, "IMAGE",
1151 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1152 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR. %s",
1153 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling),
1154 validation_error_map[VALIDATION_ERROR_18a00010]);
1155 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001156 }
1157 return skip;
1158}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001159
1160// Returns true if [x, xoffset] and [y, yoffset] overlap
1161static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1162 bool result = false;
1163 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1164 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1165
1166 if (intersection_max > intersection_min) {
1167 result = true;
1168 }
1169 return result;
1170}
1171
1172// Returns true if two VkImageCopy structures overlap
1173static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1174 bool result = false;
1175 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1176 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1177 dst->dstSubresource.layerCount))) {
1178 result = true;
1179 switch (type) {
1180 case VK_IMAGE_TYPE_3D:
1181 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1182 // Intentionally fall through to 2D case
1183 case VK_IMAGE_TYPE_2D:
1184 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1185 // Intentionally fall through to 1D case
1186 case VK_IMAGE_TYPE_1D:
1187 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1188 break;
1189 default:
1190 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1191 assert(false);
1192 }
1193 }
1194 return result;
1195}
1196
Dave Houltonfc1a4052017-04-27 14:32:45 -06001197// Returns non-zero if offset and extent exceed image extents
1198static const uint32_t x_bit = 1;
1199static const uint32_t y_bit = 2;
1200static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001201static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001202 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001203 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001204 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1205 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001206 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001207 }
1208 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1209 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001210 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001211 }
1212 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1213 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001214 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001215 }
1216 return result;
1217}
1218
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001219// Test if two VkExtent3D structs are equivalent
1220static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1221 bool result = true;
1222 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1223 (extent->depth != other_extent->depth)) {
1224 result = false;
1225 }
1226 return result;
1227}
1228
Dave Houltonee281a52017-12-08 13:51:02 -07001229// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1230// Destination image texel extents must be adjusted by block size for the dest validation checks
1231VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1232 VkExtent3D adjusted_extent = extent;
1233 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1234 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1235 adjusted_extent.width /= block_size.width;
1236 adjusted_extent.height /= block_size.height;
1237 adjusted_extent.depth /= block_size.depth;
1238 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1239 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1240 adjusted_extent.width *= block_size.width;
1241 adjusted_extent.height *= block_size.height;
1242 adjusted_extent.depth *= block_size.depth;
1243 }
1244 return adjusted_extent;
1245}
1246
Dave Houlton6f9059e2017-05-02 17:15:13 -06001247// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001248static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1249 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001250
1251 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001252 if (mip >= img->createInfo.mipLevels) {
1253 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001254 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001255
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001256 // 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 -06001257 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001258 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1259 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1260 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001261
Dave Houlton6f9059e2017-05-02 17:15:13 -06001262 // Image arrays have an effective z extent that isn't diminished by mip level
1263 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001264 extent.depth = img->createInfo.arrayLayers;
1265 }
1266
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001267 return extent;
1268}
1269
1270// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001271static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001272 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1273}
1274
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001275// Test if the extent argument has any dimensions set to 0.
1276static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1277 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1278}
1279
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001280// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1281static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1282 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1283 VkExtent3D granularity = {0, 0, 0};
1284 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1285 if (pPool) {
1286 granularity =
1287 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001288 if (FormatIsCompressed(img->createInfo.format)) {
1289 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001290 granularity.width *= block_size.width;
1291 granularity.height *= block_size.height;
1292 }
1293 }
1294 return granularity;
1295}
1296
1297// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1298static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1299 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001300 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1301 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001302 valid = false;
1303 }
1304 return valid;
1305}
1306
1307// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1308static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1309 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1310 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1311 bool skip = false;
1312 VkExtent3D offset_extent = {};
1313 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1314 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1315 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001316 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001317 // 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 -07001318 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001319 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1320 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1321 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1322 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1323 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001324 }
1325 } else {
1326 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1327 // integer multiples of the image transfer granularity.
1328 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001329 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1330 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1331 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1332 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1333 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1334 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001335 }
1336 }
1337 return skip;
1338}
1339
1340// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1341static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1342 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001343 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001344 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1345 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001346 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001347 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1348 // subresource extent.
1349 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001350 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1351 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1352 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1353 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1354 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1355 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001356 }
1357 } else {
1358 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1359 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1360 // subresource extent dimensions.
1361 VkExtent3D offset_extent_sum = {};
1362 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1363 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1364 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001365 bool x_ok = true;
1366 bool y_ok = true;
1367 bool z_ok = true;
1368 switch (image_type) {
1369 case VK_IMAGE_TYPE_3D:
1370 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1371 (subresource_extent->depth == offset_extent_sum.depth));
1372 // Intentionally fall through to 2D case
1373 case VK_IMAGE_TYPE_2D:
1374 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1375 (subresource_extent->height == offset_extent_sum.height));
1376 // Intentionally fall through to 1D case
1377 case VK_IMAGE_TYPE_1D:
1378 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1379 (subresource_extent->width == offset_extent_sum.width));
1380 break;
1381 default:
1382 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1383 assert(false);
1384 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001385 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001386 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001387 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001388 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001389 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1390 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1391 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1392 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1393 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1394 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1395 }
1396 }
1397 return skip;
1398}
1399
1400// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1401static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1402 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1403 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1404
1405 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001406 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001408 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001409 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1410 "transfer granularity width (%d).",
1411 function, i, member, value, granularity);
1412 }
1413 return skip;
1414}
1415
1416// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1417static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1418 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1419 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1420 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001421 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001422 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001423 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001424 "%s: pRegion[%d].%s (%" PRIdLEAST64
1425 ") must be an even integer multiple of this command buffer's queue family image transfer "
1426 "granularity width (%d).",
1427 function, i, member, value, granularity);
1428 }
1429 return skip;
1430}
1431
1432// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1433bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1434 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1435 const uint32_t i, const char *function) {
1436 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001437 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001438 // TODO: Add granularity checking for compressed formats
1439
1440 // bufferRowLength must be a multiple of the compressed texel block width
1441 // bufferImageHeight must be a multiple of the compressed texel block height
1442 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1443 // bufferOffset must be a multiple of the compressed texel block size in bytes
1444 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1445 // must equal the image subresource width
1446 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1447 // must equal the image subresource height
1448 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1449 // must equal the image subresource depth
1450 } else {
1451 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1452 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1453 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1454 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1455 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1456 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1457 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001458 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001459 }
1460 return skip;
1461}
1462
1463// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1464bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001465 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1466 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001467 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001468 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001469 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001470 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001471 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001472 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001473 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001474 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001475
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001476 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001477 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001478 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001479 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001480 const VkExtent3D dest_effective_extent =
1481 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001482 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001483 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001484 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001485 return skip;
1486}
1487
Dave Houlton6f9059e2017-05-02 17:15:13 -06001488// Validate contents of a VkImageCopy struct
1489bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1490 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1491 bool skip = false;
1492
1493 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001494 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001495
1496 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001497 const VkExtent3D src_copy_extent = region.extent;
1498 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001499 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1500
Dave Houlton6f9059e2017-05-02 17:15:13 -06001501 bool slice_override = false;
1502 uint32_t depth_slices = 0;
1503
1504 // Special case for copying between a 1D/2D array and a 3D image
1505 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1506 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001507 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001508 slice_override = (depth_slices != 1);
1509 } 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 -07001510 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001511 slice_override = (depth_slices != 1);
1512 }
1513
1514 // Do all checks on source image
1515 //
1516 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001517 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1518 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1519 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1520 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1521 "be 0 and 1, respectively. %s",
1522 i, region.srcOffset.y, src_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001523 }
1524 }
1525
1526 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (src_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001527 if ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth)) {
1528 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1529 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00128, "IMAGE",
1530 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1531 "these must be 0 and 1, respectively. %s",
1532 i, region.srcOffset.z, src_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00128]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001533 }
1534 }
1535
1536 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001537 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001538 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001539 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001540 skip |=
1541 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001542 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001543 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1544 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001545 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001546 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001547 }
1548 }
1549 } else { // Pre maint 1
1550 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001551 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001552 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1553 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1554 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1555 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1556 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001557 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001558 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001559 }
1560 }
1561 }
1562
1563 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
Dave Houltonee281a52017-12-08 13:51:02 -07001564 if ((region.srcSubresource.baseArrayLayer >= src_state->createInfo.arrayLayers) ||
1565 (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount > src_state->createInfo.arrayLayers)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001566 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001567 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0012a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001568 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer (%d) must be less than the source image's "
1569 "arrayLayers (%d), and the sum of baseArrayLayer and srcSubresource.layerCount (%d) must be less than "
1570 "or equal to the source image's arrayLayers. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001571 i, region.srcSubresource.baseArrayLayer, src_state->createInfo.arrayLayers,
1572 region.srcSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c0012a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001573 }
1574
1575 // Checks that apply only to compressed images
1576 if (FormatIsCompressed(src_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001577 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001578
1579 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001580 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1581 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1582 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001583 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001584 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001585 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1586 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001587 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001588 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001589 }
1590
Dave Houlton94a00372017-12-14 15:08:47 -07001591 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001592 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1593 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001594 skip |=
1595 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001596 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001597 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1598 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001599 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001600 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001601 }
1602
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001603 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001604 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1605 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001606 skip |=
1607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001608 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001609 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1610 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001611 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001612 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001613 }
1614
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001615 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001616 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1617 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001618 skip |=
1619 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001620 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001621 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1622 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001623 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001624 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001625 }
1626 } // Compressed
1627
1628 // Do all checks on dest image
1629 //
1630 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001631 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
1632 skip |= log_msg(
1633 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1634 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1635 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images these must "
1636 "be 0 and 1, respectively. %s",
1637 i, region.dstOffset.y, dst_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001638 }
1639 }
1640
1641 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001642 if ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001643 skip |=
1644 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001645 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00134, "IMAGE",
Dave Houltonee281a52017-12-08 13:51:02 -07001646 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and dst_copy_extent.depth is %d. For 1D and 2D images "
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001647 "these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001648 i, region.dstOffset.z, dst_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00134]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001649 }
1650 }
1651
1652 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001653 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001654 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001655 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001656 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1657 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001658 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001659 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001660 }
1661 }
1662 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001663 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001664 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001665 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001666 skip |=
1667 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001668 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001669 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1670 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001671 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001672 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001673 }
1674 }
1675 } else { // Pre maint 1
1676 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001677 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001678 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1679 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1680 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1681 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1682 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001683 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001684 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001685 }
1686 }
1687 }
1688
1689 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
Dave Houltonee281a52017-12-08 13:51:02 -07001690 if ((region.dstSubresource.baseArrayLayer >= dst_state->createInfo.arrayLayers) ||
1691 (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount > dst_state->createInfo.arrayLayers)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001692 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001693 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00136, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001694 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer (%d) must be less than the dest image's "
1695 "arrayLayers (%d), and the sum of baseArrayLayer and dstSubresource.layerCount (%d) must be less than "
1696 "or equal to the dest image's arrayLayers. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001697 i, region.dstSubresource.baseArrayLayer, dst_state->createInfo.arrayLayers,
1698 region.dstSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c00136]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001699 }
1700
1701 // Checks that apply only to compressed images
1702 if (FormatIsCompressed(dst_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001703 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001704
1705 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001706 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1707 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1708 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001709 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001710 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001711 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1712 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001713 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001714 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001715 }
1716
Dave Houlton94a00372017-12-14 15:08:47 -07001717 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001718 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1719 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
1720 skip |= log_msg(
1721 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1722 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
1723 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture block "
1724 "width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
1725 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width,
1726 validation_error_map[VALIDATION_ERROR_09c00146]);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001727 }
1728
Dave Houltonee281a52017-12-08 13:51:02 -07001729 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1730 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1731 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
1732 skip |= log_msg(
1733 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1734 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
1735 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed texture block "
1736 "height (%d), or when added to dstOffset.y (%d) must equal the image subresource height (%d). %s.",
1737 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height,
1738 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001739 }
1740
Dave Houltonee281a52017-12-08 13:51:02 -07001741 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1742 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1743 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
1744 skip |= log_msg(
1745 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1746 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
1747 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture block "
1748 "depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1749 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth,
1750 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001751 }
1752 } // Compressed
1753 }
1754 return skip;
1755}
1756
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001757bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001758 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1759 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001760 bool skip = false;
1761 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001762 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1763
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001764 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1765
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001766 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001767 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001768
1769 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1770 VkExtent3D src_copy_extent = region.extent;
1771 VkExtent3D dst_copy_extent =
1772 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1773
Dave Houlton6f9059e2017-05-02 17:15:13 -06001774 bool slice_override = false;
1775 uint32_t depth_slices = 0;
1776
1777 // Special case for copying between a 1D/2D array and a 3D image
1778 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1779 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1780 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001781 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001782 slice_override = (depth_slices != 1);
1783 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1784 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001785 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001786 slice_override = (depth_slices != 1);
1787 }
1788
Dave Houltonee281a52017-12-08 13:51:02 -07001789 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001790 std::stringstream ss;
1791 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001792 skip |=
1793 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1794 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001795 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001796
Dave Houltonee281a52017-12-08 13:51:02 -07001797 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001798 std::stringstream ss;
1799 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001800 skip |=
1801 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1802 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001803 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001804
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001805 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001806 // No chance of mismatch if we're overriding depth slice count
1807 if (!slice_override) {
1808 // The number of depth slices in srcSubresource and dstSubresource must match
1809 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1810 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001811 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1812 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001813 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001814 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1815 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001816 if (src_slices != dst_slices) {
1817 std::stringstream ss;
1818 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1819 << "] do not match";
1820 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001821 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1822 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001823 }
1824 }
1825 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001826 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001827 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001828 std::stringstream ss;
1829 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1830 << "] do not match";
1831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001832 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1833 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001834 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001835 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001836
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001837 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001838 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001839 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1840 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001841 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1842 validation_error_map[VALIDATION_ERROR_09c00112]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001843 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001844
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001845 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001846 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001847 std::stringstream ss;
1848 ss << "vkCmdCopyImage: pRegion[" << i
1849 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1850 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001851 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1852 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001853 }
1854
1855 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001856 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001857 std::stringstream ss;
1858 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1859 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001860 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1861 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001862 }
1863
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001864 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001865 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1866 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867 std::stringstream ss;
1868 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1869 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001870 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1871 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001872 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001873
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001874 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1875 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001876 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1877 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001878 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1879 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001880 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s. %s", str,
1881 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001882 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001883
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001884 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001885 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001886 std::stringstream ss;
1887 ss << "vkCmdCopyImage: pRegions[" << i
1888 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1889 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001890 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1891 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001892 }
Dave Houltonee281a52017-12-08 13:51:02 -07001893 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001894 std::stringstream ss;
1895 ss << "vkCmdCopyImage: pRegions[" << i
1896 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001898 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1899 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001900 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001901
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001902 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1903 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001904 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001905 std::stringstream ss;
1906 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001907 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001908 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001909 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1910 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001911 }
Dave Houltonee281a52017-12-08 13:51:02 -07001912 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001913 std::stringstream ss;
1914 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001915 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001916 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001917 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1918 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001919 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001920
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001921 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1922 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1923 // 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 -07001924 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1925 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001926 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001927 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1928 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1929 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1930 << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001931 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001932 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s. %s",
1933 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001934 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001935
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001936 // 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 -07001937 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1938 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001939 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001940 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1941 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1942 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1943 << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001944 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001945 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1946 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001947 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001948 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001949
Dave Houltonfc1a4052017-04-27 14:32:45 -06001950 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001951 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1952 if (slice_override) src_copy_extent.depth = depth_slices;
1953 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001954 if (extent_check & x_bit) {
1955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001956 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1958 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001959 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001960 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001961 }
1962
1963 if (extent_check & y_bit) {
1964 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001965 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001966 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1967 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001968 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001969 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001970 }
1971 if (extent_check & z_bit) {
1972 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001973 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001974 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1975 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001976 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001977 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001978 }
1979
Dave Houltonee281a52017-12-08 13:51:02 -07001980 // Adjust dest extent if necessary
1981 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1982 if (slice_override) dst_copy_extent.depth = depth_slices;
1983
1984 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001985 if (extent_check & x_bit) {
1986 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001987 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001988 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1989 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001990 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001991 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001992 }
1993 if (extent_check & y_bit) {
1994 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001995 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001996 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1997 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001998 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001999 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002000 }
2001 if (extent_check & z_bit) {
2002 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002003 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06002004 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2005 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07002006 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002007 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002008 }
2009
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002010 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2011 // must not overlap in memory
2012 if (src_image_state->image == dst_image_state->image) {
2013 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonee281a52017-12-08 13:51:02 -07002014 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002015 std::stringstream ss;
2016 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2017 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002018 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
2019 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002020 }
2021 }
2022 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002023 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002024
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002025 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2026 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2027 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002028 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002029 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2030 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002031 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2032 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 }
2034 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002035 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2036 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 if (srcSize != destSize) {
2038 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2039 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002040 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
2041 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002042 }
2043 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002044
Dave Houlton33c22b72017-02-28 13:16:02 -07002045 // Source and dest image sample counts must match
2046 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2047 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2048 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002049 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
2050 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07002051 }
2052
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002053 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2054 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002056 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002057 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002058 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002059 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002060 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002061 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002062 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002063 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002064 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002065 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002066 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002067 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002068 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002069 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002070 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2071 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002072 }
2073
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002074 return skip;
2075}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002076
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002077void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002078 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2079 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2080 // Make sure that all image slices are updated to correct layout
2081 for (uint32_t i = 0; i < region_count; ++i) {
2082 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2083 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2084 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002085 // Update bindings between images and cmd buffer
2086 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2087 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002088 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002089 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002090 function = [=]() {
2091 SetImageMemoryValid(device_data, dst_image_state, true);
2092 return false;
2093 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002094 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002095}
2096
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002097// Returns true if sub_rect is entirely contained within rect
2098static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2099 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2100 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2101 return false;
2102 return true;
2103}
2104
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002105bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2106 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002107 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002108 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2109
2110 bool skip = false;
2111 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002112 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2113 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002114 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002115 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002116 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002117 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2118 // 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 -07002119 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2120 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002121 skip |=
2122 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002123 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +01002124 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2125 " prior to any Draw Cmds."
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002126 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
Petr Kraus13c98a62017-12-09 00:22:39 +01002127 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002128 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002129 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002130 }
2131
2132 // Validate that attachment is in reference list of active subpass
2133 if (cb_node->activeRenderPass) {
2134 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2135 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002136 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002137
2138 for (uint32_t i = 0; i < attachmentCount; i++) {
2139 auto clear_desc = &pAttachments[i];
2140 VkImageView image_view = VK_NULL_HANDLE;
2141
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002142 if (0 == clear_desc->aspectMask) {
2143 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002144 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2145 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002146 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2147 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002148 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2149 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002150 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002151 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002152 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2153 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2154 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2155 clear_desc->colorAttachment, cb_node->activeSubpass,
2156 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002157 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2158 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002159 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2160 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002161 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2162 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002163 } else {
2164 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002165 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002166 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002167 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2168 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2169 char const str[] =
2170 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
2171 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002172 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2173 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002174 }
2175 } else { // Must be depth and/or stencil
2176 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2177 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2178 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
2179 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002180 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2181 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002182 }
2183 if (!subpass_desc->pDepthStencilAttachment ||
2184 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2185 skip |= log_msg(
2186 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002187 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002188 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002189 } else {
2190 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2191 }
2192 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002193 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002194 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002195 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002196 // The rectangular region specified by a given element of pRects must be contained within the render area of
2197 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002198 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
2199 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
2200 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002201 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002202 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002203 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2204 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002205 j, validation_error_map[VALIDATION_ERROR_18600020]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002206 }
2207 // The layers specified by a given element of pRects must be contained within every attachment that
2208 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002209 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002210 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2211 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002212 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002213 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002214 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002215 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
2216 "pAttachment[%d]. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002217 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002218 }
2219 }
2220 }
2221 }
2222 }
2223 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002224}
2225
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002226bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002227 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002228 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002229 bool skip = false;
2230 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002231 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2232 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2233 skip |=
2234 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002235 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002236 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002237
2238 // For each region, the number of layers in the image subresource should not be zero
2239 // For each region, src and dest image aspect must be color only
2240 for (uint32_t i = 0; i < regionCount; i++) {
2241 if (pRegions[i].srcSubresource.layerCount == 0) {
2242 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002243 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002244 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002245 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002246 if (pRegions[i].dstSubresource.layerCount == 0) {
2247 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002248 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002249 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002250 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002251 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2252 skip |= log_msg(
2253 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002254 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002255 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002256 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002257 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002258 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2259 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2260 char const str[] =
2261 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2262 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002263 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2264 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002265 }
2266 }
2267
2268 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2269 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002270 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002271 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002272 }
2273 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2274 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002275 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002276 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002277 }
2278 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2279 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2280 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002281 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2282 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002283 }
2284 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2285 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2286 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002287 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2288 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002289 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002290 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002291 } else {
2292 assert(0);
2293 }
2294 return skip;
2295}
2296
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002297void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2298 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002299 // Update bindings between images and cmd buffer
2300 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2301 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2302
2303 std::function<bool()> function = [=]() {
2304 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2305 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002306 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002307 function = [=]() {
2308 SetImageMemoryValid(device_data, dst_image_state, true);
2309 return false;
2310 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002311 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002312}
2313
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002314bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002315 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2316 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002317 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2318
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002319 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002320 if (cb_node) {
2321 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2322 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002323 if (cb_node && src_image_state && dst_image_state) {
2324 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002325 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002326 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002327 VALIDATION_ERROR_184001d4);
2328 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2329 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2330 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2331 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2332 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2333 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2334 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002335 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002336 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002337 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002338
Dave Houlton33c2d252017-06-09 17:08:32 -06002339 VkFormat src_format = src_image_state->createInfo.format;
2340 VkFormat dst_format = dst_image_state->createInfo.format;
2341 VkImageType src_type = src_image_state->createInfo.imageType;
2342 VkImageType dst_type = dst_image_state->createInfo.imageType;
2343
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002344 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002345 VkImageTiling tiling = src_image_state->createInfo.tiling;
2346 VkFormatFeatureFlags flags =
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002347 (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002348 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2350 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2351 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2352 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2353 }
2354
2355 if ((VK_FILTER_LINEAR == filter) &&
2356 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2357 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2358 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2359 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2360 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2361 }
2362
2363 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2364 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
2365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2366 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2367 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2368 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2369 }
2370
2371 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2372 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2373 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2374 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2375 validation_error_map[VALIDATION_ERROR_184001da]);
2376 }
2377
2378 props = GetFormatProperties(device_data, dst_format);
2379 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002380 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002381 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2382 skip |=
2383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2384 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2385 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2386 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2387 }
2388
2389 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2390 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2391 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2392 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2393 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2394 validation_error_map[VALIDATION_ERROR_184001c8]);
2395 }
2396
2397 // Validate consistency for unsigned formats
2398 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2399 std::stringstream ss;
2400 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2401 << "the other one must also have unsigned integer format. "
2402 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2403 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2404 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2405 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2406 }
2407
2408 // Validate consistency for signed formats
2409 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2410 std::stringstream ss;
2411 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2412 << "the other one must also have signed integer format. "
2413 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2414 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2415 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2416 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2417 }
2418
2419 // Validate filter for Depth/Stencil formats
2420 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2421 std::stringstream ss;
2422 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2423 << "then filter must be VK_FILTER_NEAREST.";
2424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2425 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d0, "IMAGE", "%s. %s",
2426 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2427 }
2428
2429 // Validate aspect bits and formats for depth/stencil images
2430 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2431 if (src_format != dst_format) {
2432 std::stringstream ss;
2433 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2434 << "stencil, the other one must have exactly the same format. "
2435 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2436 << string_VkFormat(dst_format);
2437 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2438 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2439 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2440 }
2441
2442#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2443 for (uint32_t i = 0; i < regionCount; i++) {
2444 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2445
2446 if (FormatIsDepthAndStencil(src_format)) {
2447 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2448 std::stringstream ss;
2449 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
2450 "VK_IMAGE_ASPECT_DEPTH_BIT "
2451 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2452 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2453 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2454 "%s", ss.str().c_str());
2455 }
2456 }
2457 else if (FormatIsStencilOnly(src_format)) {
2458 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2459 std::stringstream ss;
2460 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2461 << "set in both the srcImage and dstImage";
2462 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2463 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2464 "%s", ss.str().c_str());
2465 }
2466 }
2467 else if (FormatIsDepthOnly(src_format)) {
2468 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2469 std::stringstream ss;
2470 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2471 << "set in both the srcImage and dstImage";
2472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2473 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2474 "%s", ss.str().c_str());
2475 }
2476 }
2477 }
2478#endif
2479 } // Depth or Stencil
2480
2481 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002482 for (uint32_t i = 0; i < region_count; i++) {
2483 const VkImageBlit rgn = regions[i];
2484 bool hit_error = false;
2485 skip |=
2486 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2487 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2488 skip |=
2489 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2490 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002491
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002492 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002493 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2494 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002495 std::stringstream ss;
2496 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2497 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002498 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2499 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002500 }
Dave Houlton48989f32017-05-26 15:01:46 -06002501 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2502 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002503 std::stringstream ss;
2504 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2505 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002506 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2507 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002508 }
Dave Houlton48989f32017-05-26 15:01:46 -06002509 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002510 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2511 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002512 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002513 }
Dave Houlton48989f32017-05-26 15:01:46 -06002514 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002515 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2516 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002517 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002518 }
2519
2520 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002521 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002522 skip |=
2523 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002524 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002525 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002526 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002527 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002528
Dave Houlton48989f32017-05-26 15:01:46 -06002529 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002530 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002531 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002532 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002533 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002534 }
Dave Houlton48989f32017-05-26 15:01:46 -06002535
Dave Houlton33c2d252017-06-09 17:08:32 -06002536 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2537 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2538 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2539 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2540 "image format %s. %s",
2541 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2542 validation_error_map[VALIDATION_ERROR_09a001e2]);
2543 }
2544
2545 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2546 skip |= log_msg(
2547 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2548 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2549 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2550 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2551 }
2552
Dave Houlton48989f32017-05-26 15:01:46 -06002553 // Validate source image offsets
2554 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002555 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002556 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2557 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2558 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2559 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2560 "of (%1d, %1d). These must be (0, 1). %s",
2561 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2562 }
2563 }
2564
Dave Houlton33c2d252017-06-09 17:08:32 -06002565 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002566 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2567 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2568 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2569 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2570 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2571 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2572 }
2573 }
2574
Dave Houlton33c2d252017-06-09 17:08:32 -06002575 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002576 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2577 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002578 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002579 skip |= log_msg(
2580 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2581 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2582 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2583 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2584 }
2585 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2586 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002587 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002588 skip |= log_msg(
2589 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2590 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2591 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2592 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2593 }
2594 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2595 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002596 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002597 skip |= log_msg(
2598 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2599 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2600 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2601 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2602 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002603 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2604 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2605 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2606 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2607 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2608 } else if (oob) {
2609 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2610 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2611 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2612 validation_error_map[VALIDATION_ERROR_184001ae]);
2613 }
Dave Houlton48989f32017-05-26 15:01:46 -06002614
2615 // Validate dest image offsets
2616 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002617 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002618 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2619 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2620 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2621 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2622 "(%1d, %1d). These must be (0, 1). %s",
2623 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2624 }
2625 }
2626
Dave Houlton33c2d252017-06-09 17:08:32 -06002627 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002628 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2629 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2630 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2631 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2632 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2633 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2634 }
2635 }
2636
Dave Houlton33c2d252017-06-09 17:08:32 -06002637 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002638 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2639 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002640 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002641 skip |= log_msg(
2642 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2643 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2644 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2645 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2646 }
2647 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2648 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002649 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002650 skip |= log_msg(
2651 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2652 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2653 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2654 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2655 }
2656 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2657 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002658 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002659 skip |= log_msg(
2660 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2661 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2662 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2663 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2664 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002665 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002666 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton33c2d252017-06-09 17:08:32 -06002667 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2668 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2669 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2670 } else if (oob) {
2671 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2672 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2673 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2674 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002675 }
2676
Dave Houlton33c2d252017-06-09 17:08:32 -06002677 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2678 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2679 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2681 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2682 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2683 "layerCount other than 1. %s",
2684 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002685 }
2686 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002687 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002688 } else {
2689 assert(0);
2690 }
2691 return skip;
2692}
2693
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002694void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002695 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2696 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2697 // Make sure that all image slices are updated to correct layout
2698 for (uint32_t i = 0; i < region_count; ++i) {
2699 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2700 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2701 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002702 // Update bindings between images and cmd buffer
2703 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2704 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2705
2706 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002707 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002708 function = [=]() {
2709 SetImageMemoryValid(device_data, dst_image_state, true);
2710 return false;
2711 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002712 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002713}
2714
Tony Barbourdf013b92017-01-25 12:53:48 -07002715// This validates that the initial layout specified in the command buffer for
2716// the IMAGE is the same
2717// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002718bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002719 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const & globalImageLayoutMap,
2720 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> & overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002721 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002722 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002723 for (auto cb_image_data : pCB->imageLayoutMap) {
2724 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002725
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002726 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
2727 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002728 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2729 // TODO: Set memory invalid which is in mem_tracker currently
2730 } else if (imageLayout != cb_image_data.second.initialLayout) {
2731 if (cb_image_data.first.hasSubresource) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002732 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2733 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2734 "Cannot submit cmd buffer using image (0x%" PRIx64
2735 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
2736 "with layout %s when first use is %s.",
2737 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2738 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2739 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002740 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2742 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2743 "Cannot submit cmd buffer using image (0x%" PRIx64
2744 ") with layout %s when "
2745 "first use is %s.",
2746 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2747 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002748 }
2749 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002750 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002751 }
2752 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002753 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002754}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002755
Tony Barbourdf013b92017-01-25 12:53:48 -07002756void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2757 for (auto cb_image_data : pCB->imageLayoutMap) {
2758 VkImageLayout imageLayout;
2759 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2760 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2761 }
2762}
2763
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002764// Print readable FlagBits in FlagMask
2765static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2766 std::string result;
2767 std::string separator;
2768
2769 if (accessMask == 0) {
2770 result = "[None]";
2771 } else {
2772 result = "[";
2773 for (auto i = 0; i < 32; i++) {
2774 if (accessMask & (1 << i)) {
2775 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2776 separator = " | ";
2777 }
2778 }
2779 result = result + "]";
2780 }
2781 return result;
2782}
2783
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002784// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2785// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002786// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002787static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2788 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2789 const char *type) {
2790 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2791 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002792
2793 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2794 if (accessMask & ~(required_bit | optional_bits)) {
2795 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002796 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002797 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002798 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2799 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002800 }
2801 } else {
2802 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002803 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002804 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002805 "%s AccessMask %d %s must contain at least one of access bits %d "
2806 "%s when layout is %s, unless the app has previously added a "
2807 "barrier for this transition.",
2808 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2809 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002810 } else {
2811 std::string opt_bits;
2812 if (optional_bits != 0) {
2813 std::stringstream ss;
2814 ss << optional_bits;
2815 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2816 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002817 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002818 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002819 "%s AccessMask %d %s must have required access bit %d %s %s when "
2820 "layout is %s, unless the app has previously added a barrier for "
2821 "this transition.",
2822 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2823 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002824 }
2825 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002826 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002827}
2828
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002829// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002830// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2831// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002832bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002833 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2834 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002835 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2836 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2837 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2838 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002839 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002840 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2841 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002842 }
2843 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002844 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002845}
2846
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002847bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2848 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002849 bool skip = false;
2850
Jason Ekstranda1906302017-12-03 20:16:32 -08002851 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2852 VkFormat format = pCreateInfo->pAttachments[i].format;
2853 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2854 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2855 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2856 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
2857 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2858 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
2859 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
2860 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
2861 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
2862 "image truely is undefined at the start of the render pass.");
2863 }
2864 if (FormatHasStencil(format) &&
2865 pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2866 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
2867 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2868 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
2869 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
2870 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
2871 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
2872 "image truely is undefined at the start of the render pass.");
2873 }
2874 }
2875 }
2876
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002877 // Track when we're observing the first use of an attachment
2878 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2879 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2880 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002881
2882 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2883 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2884 auto attach_index = subpass.pInputAttachments[j].attachment;
2885 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2886
2887 switch (subpass.pInputAttachments[j].layout) {
2888 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2889 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2890 // These are ideal.
2891 break;
2892
2893 case VK_IMAGE_LAYOUT_GENERAL:
2894 // May not be optimal. TODO: reconsider this warning based on other constraints.
2895 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2896 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2897 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2898 break;
2899
2900 default:
2901 // No other layouts are acceptable
2902 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2903 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2904 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2905 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2906 }
2907
2908 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2909 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2910 subpass.pDepthStencilAttachment->attachment == attach_index &&
2911 subpass.pDepthStencilAttachment->layout != layout;
2912 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2913 found_layout_mismatch =
2914 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2915 }
2916 if (found_layout_mismatch) {
2917 skip |= log_msg(
2918 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002919 VALIDATION_ERROR_140006ae, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002920 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a depth/color "
2921 "attachment with a different layout. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002922 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002923 }
2924
2925 if (attach_first_use[attach_index]) {
2926 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2927 pCreateInfo->pAttachments[attach_index]);
2928
2929 bool used_as_depth =
2930 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2931 bool used_as_color = false;
2932 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2933 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2934 }
2935 if (!used_as_depth && !used_as_color &&
2936 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2937 skip |= log_msg(
2938 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002939 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002940 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002941 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002942 }
2943 }
2944 attach_first_use[attach_index] = false;
2945 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002946 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2947 auto attach_index = subpass.pColorAttachments[j].attachment;
2948 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2949
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002950 // TODO: Need a way to validate shared presentable images here, currently just allowing
2951 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2952 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002953 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002954 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002955 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002956 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2957 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002958 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002959
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002960 case VK_IMAGE_LAYOUT_GENERAL:
2961 // May not be optimal; TODO: reconsider this warning based on other constraints?
2962 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2963 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2964 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2965 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002966
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002967 default:
2968 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2969 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2970 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2971 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002972 }
2973
2974 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002975 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2976 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002977 }
2978 attach_first_use[attach_index] = false;
2979 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002980
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002981 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2982 switch (subpass.pDepthStencilAttachment->layout) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06002983 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2984 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2985 // These are ideal.
2986 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002987
Lenny Komowb79f04a2017-09-18 17:07:00 -06002988 case VK_IMAGE_LAYOUT_GENERAL:
2989 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2990 // doing a bunch of transitions.
2991 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2992 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2993 "GENERAL layout for depth attachment may not give optimal performance.");
2994 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002995
Lenny Komowb79f04a2017-09-18 17:07:00 -06002996 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2997 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2998 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2999 break;
3000 } else {
3001 // Intentionally fall through to generic error message
3002 }
3003
3004 default:
3005 // No other layouts are acceptable
3006 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3007 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3008 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3009 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3010 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003011 }
3012
3013 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3014 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003015 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
3016 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003017 }
3018 attach_first_use[attach_index] = false;
3019 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003020 }
3021 return skip;
3022}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003023
3024// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003025bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3026 VkDeviceSize offset, VkDeviceSize end_offset) {
3027 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3028 bool skip = false;
3029 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3030 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003031 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3032 for (auto image_handle : mem_info->bound_images) {
3033 auto img_it = mem_info->bound_ranges.find(image_handle);
3034 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003035 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003036 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003037 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003038 for (auto layout : layouts) {
3039 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003040 skip |=
3041 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
3042 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3043 "Mapping an image with layout %s can result in undefined behavior if this memory is "
3044 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
3045 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003046 }
3047 }
3048 }
3049 }
3050 }
3051 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003052 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003053}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003054
3055// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3056// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003057static 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 -06003058 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003059 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003060
3061 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003062 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003063 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003064 if (strict) {
3065 correct_usage = ((actual & desired) == desired);
3066 } else {
3067 correct_usage = ((actual & desired) != 0);
3068 }
3069 if (!correct_usage) {
3070 if (msgCode == -1) {
3071 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06003072 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
Petr Kraus13c98a62017-12-09 00:22:39 +01003073 MEMTRACK_INVALID_USAGE_FLAG, "MEM", "Invalid usage flag for %s 0x%" PRIx64
3074 " used by %s. In this case, %s should have %s set during creation.",
Mark Lobodzinski33826372017-04-13 11:10:11 -06003075 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003076 } else {
3077 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Petr Kraus13c98a62017-12-09 00:22:39 +01003078 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
3079 msgCode, "MEM", "Invalid usage flag for %s 0x%" PRIx64
3080 " used by %s. In this case, %s should have %s set during creation. %s",
3081 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003082 }
3083 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003084 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003085}
3086
3087// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3088// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003089bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003090 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003091 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3092 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003093}
3094
3095// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3096// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003097bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003098 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003099 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3100 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003101}
3102
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003103bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003104 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003105 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3106
Chris Forbese0f511c2017-06-14 12:38:01 -07003107 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003108
3109 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3110 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003111 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003112 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3113 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003114 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003115 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003116
3117 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
3118 skip |=
3119 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Chris Forbese0f511c2017-06-14 12:38:01 -07003120 VALIDATION_ERROR_01400728, "DS",
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003121 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003122 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3123 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003124 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003125
3126 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
3127 skip |=
3128 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Chris Forbese0f511c2017-06-14 12:38:01 -07003129 VALIDATION_ERROR_0140072a, "DS",
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003130 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003131 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3132 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003133 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003134 return skip;
3135}
3136
3137void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3138 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3139 GetBufferMap(device_data)
3140 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3141}
3142
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003143bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3144 bool skip = false;
3145 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003146 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3147 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003148 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003149 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3150 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003151 skip |= ValidateBufferUsageFlags(
3152 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 -06003153 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003154 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003155 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003156}
3157
3158void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3159 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3160}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003161
3162// For the given format verify that the aspect masks make sense
3163bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3164 const char *func_name) {
3165 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3166 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003167 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003168 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003169 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003170 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003171 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003172 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003173 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003174 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003175 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003176 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003177 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003178 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003179 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003180 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003181 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003182 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003183 "%s: Depth/stencil image formats must have "
3184 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
3185 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003186 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003187 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003188 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003189 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003190 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3191 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003192 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003193 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003194 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003195 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003196 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003197 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003198 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003199 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003200 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003201 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003202 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003203 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003204 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003205 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003206 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003207 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003208 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003209 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003210 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003211 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003212 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003213 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003214 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003215 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003216 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003217 }
3218 }
3219 return skip;
3220}
3221
Petr Krausffa94af2017-08-08 21:46:02 +02003222struct SubresourceRangeErrorCodes {
3223 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3224};
3225
3226bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3227 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3228 const char *image_layer_count_var_name, const uint64_t image_handle,
3229 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003230 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3231 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003232
3233 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003234 if (subresourceRange.baseMipLevel >= image_mip_count) {
3235 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3236 errorCodes.base_mip_err, "IMAGE",
3237 "%s: %s.baseMipLevel (= %" PRIu32
3238 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 "). %s",
3239 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count,
3240 validation_error_map[errorCodes.base_mip_err]);
3241 }
Petr Kraus4d718682017-05-18 03:38:41 +02003242
Petr Krausffa94af2017-08-08 21:46:02 +02003243 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3244 if (subresourceRange.levelCount == 0) {
3245 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3246 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0. %s", cmd_name, param_name,
3247 validation_error_map[errorCodes.mip_count_err]);
3248 } else {
3249 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003250
Petr Krausffa94af2017-08-08 21:46:02 +02003251 if (necessary_mip_count > image_mip_count) {
3252 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3253 __LINE__, errorCodes.mip_count_err, "IMAGE",
3254 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3255 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3256 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
3257 necessary_mip_count, image_mip_count, validation_error_map[errorCodes.mip_count_err]);
3258 }
Petr Kraus4d718682017-05-18 03:38:41 +02003259 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003260 }
Petr Kraus4d718682017-05-18 03:38:41 +02003261
3262 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003263 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3264 skip |=
3265 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3266 errorCodes.base_layer_err, "IMAGE",
3267 "%s: %s.baseArrayLayer (= %" PRIu32
3268 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 "). %s",
3269 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count,
3270 validation_error_map[errorCodes.base_layer_err]);
3271 }
Petr Kraus4d718682017-05-18 03:38:41 +02003272
Petr Krausffa94af2017-08-08 21:46:02 +02003273 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3274 if (subresourceRange.layerCount == 0) {
3275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3276 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0. %s", cmd_name, param_name,
3277 validation_error_map[errorCodes.layer_count_err]);
3278 } else {
3279 const uint64_t necessary_layer_count =
3280 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003281
Petr Krausffa94af2017-08-08 21:46:02 +02003282 if (necessary_layer_count > image_layer_count) {
3283 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3284 __LINE__, errorCodes.layer_count_err, "IMAGE",
3285 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3286 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3287 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
3288 necessary_layer_count, image_layer_count_var_name, image_layer_count,
3289 validation_error_map[errorCodes.layer_count_err]);
3290 }
Petr Kraus4d718682017-05-18 03:38:41 +02003291 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003292 }
Petr Kraus4d718682017-05-18 03:38:41 +02003293
Mark Lobodzinski602de982017-02-09 11:01:33 -07003294 return skip;
3295}
3296
Petr Krausffa94af2017-08-08 21:46:02 +02003297bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3298 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3299 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3300 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3301 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3302 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3303
3304 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3305 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3306
3307 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3308 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
3309 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00b8e;
3310 subresourceRangeErrorCodes.base_layer_err =
3311 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3312 subresourceRangeErrorCodes.layer_count_err =
3313 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00b92;
3314
3315 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3316 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3317 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3318}
3319
3320bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3321 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3322 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3323 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
3324 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800b7e;
3325 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
3326 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800b82;
3327
3328 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3329 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3330 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3331}
3332
3333bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3334 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3335 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3336 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
3337 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00b86;
3338 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
3339 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00b8a;
3340
3341 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3342 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3343 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3344}
3345
3346bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3347 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3348 const char *param_name) {
3349 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3350 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
3351 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000b9e;
3352 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
3353 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000ba2;
3354
3355 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3356 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3357 subresourceRangeErrorCodes);
3358}
3359
Mark Lobodzinski602de982017-02-09 11:01:33 -07003360bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3361 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3362 bool skip = false;
3363 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3364 if (image_state) {
3365 skip |= ValidateImageUsageFlags(
3366 device_data, image_state,
3367 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06003368 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003369 false, -1, "vkCreateImageView()",
3370 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3371 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003372 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003373 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003374 skip |= ValidateCreateImageViewSubresourceRange(
3375 device_data, image_state,
3376 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3377 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003378
3379 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3380 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003381 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3382 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003383 VkFormat view_format = create_info->format;
3384 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003385 VkImageType image_type = image_state->createInfo.imageType;
3386 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003387
3388 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3389 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003390 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3391 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3392 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3393 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3394 std::stringstream ss;
3395 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3396 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3397 << ") format " << string_VkFormat(image_format)
3398 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3399 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3400 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3401 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3402 validation_error_map[VALIDATION_ERROR_0ac007f4]);
3403 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003404 }
3405 } else {
3406 // Format MUST be IDENTICAL to the format the image was created with
3407 if (image_format != view_format) {
3408 std::stringstream ss;
3409 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003410 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003411 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003412 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003413 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3414 validation_error_map[VALIDATION_ERROR_0ac007f6]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003415 }
3416 }
3417
3418 // Validate correct image aspect bits for desired formats and format consistency
3419 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003420
3421 switch (image_type) {
3422 case VK_IMAGE_TYPE_1D:
3423 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3425 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3426 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3427 string_VkImageViewType(view_type), string_VkImageType(image_type),
3428 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3429 }
3430 break;
3431 case VK_IMAGE_TYPE_2D:
3432 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3433 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3434 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3435 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3436 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
3437 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3438 string_VkImageViewType(view_type), string_VkImageType(image_type),
3439 validation_error_map[VALIDATION_ERROR_0ac007d6]);
3440 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3441 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3442 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3443 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3444 string_VkImageViewType(view_type), string_VkImageType(image_type),
3445 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3446 }
3447 }
3448 break;
3449 case VK_IMAGE_TYPE_3D:
3450 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3451 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3452 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3453 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
3454 skip |= log_msg(
3455 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3456 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3457 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3458 string_VkImageViewType(view_type), string_VkImageType(image_type),
3459 validation_error_map[VALIDATION_ERROR_0ac007da]);
3460 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3461 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
3462 skip |= log_msg(
3463 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3464 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3465 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s when the "
3466 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
3467 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled. %s",
3468 string_VkImageViewType(view_type), string_VkImageType(image_type),
3469 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3470 }
3471 } else {
3472 skip |=
3473 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3474 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3475 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3476 string_VkImageViewType(view_type), string_VkImageType(image_type),
3477 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3478 }
3479 }
3480 } else {
3481 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3482 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3483 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3484 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3485 string_VkImageViewType(view_type), string_VkImageType(image_type),
3486 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3487 }
3488 }
3489 break;
3490 default:
3491 break;
3492 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003493
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003494 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003495 bool check_tiling_features = false;
3496 VkFormatFeatureFlags tiling_features = 0;
3497 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3498 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3499 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3500 };
3501 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3502 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3503 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3504 };
3505 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3506 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003507 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003508 error_codes = linear_error_codes;
3509 check_tiling_features = true;
3510 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003511 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003512 error_codes = optimal_error_codes;
3513 check_tiling_features = true;
3514 }
3515
3516 if (check_tiling_features) {
3517 if (tiling_features == 0) {
3518 skip |=
3519 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3520 error_codes[0], "IMAGE",
3521 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3522 "%s flag set. %s",
3523 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[0]]);
3524 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
3525 skip |=
3526 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3527 error_codes[1], "IMAGE",
3528 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3529 "%s and VK_IMAGE_USAGE_SAMPLED_BIT flags set. %s",
3530 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[1]]);
3531 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
3532 skip |=
3533 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3534 error_codes[2], "IMAGE",
3535 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3536 "%s and VK_IMAGE_USAGE_STORAGE_BIT flags set. %s",
3537 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[2]]);
3538 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3539 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
3540 skip |=
3541 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3542 error_codes[3], "IMAGE",
3543 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3544 "%s and VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set. %s",
3545 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[3]]);
3546 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3547 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
3548 skip |=
3549 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3550 error_codes[4], "IMAGE",
3551 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3552 "%s and VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set. %s",
3553 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[4]]);
3554 }
3555 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003556 }
3557 return skip;
3558}
3559
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003560void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3561 auto image_view_map = GetImageViewMap(device_data);
3562 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3563
3564 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003565 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003566 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3567 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003568}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003569
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003570bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3571 BUFFER_STATE *dst_buffer_state) {
3572 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003573 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3574 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003575 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003576 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3577 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3578 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3579 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003580 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003581 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003582 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003583 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003584 return skip;
3585}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003586
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003587void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3588 BUFFER_STATE *dst_buffer_state) {
3589 // Update bindings between buffers and cmd buffer
3590 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3591 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3592
3593 std::function<bool()> function = [=]() {
3594 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3595 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003596 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003597 function = [=]() {
3598 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3599 return false;
3600 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003601 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003602}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003603
3604static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3605 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3606 bool skip = false;
3607 auto buffer_state = GetBufferState(device_data, buffer);
3608 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003609 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Petr Kraus13c98a62017-12-09 00:22:39 +01003610 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS", "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
3611 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003612 } else {
3613 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003614 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003615 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +01003616 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003617 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003618 }
3619 }
3620 return skip;
3621}
3622
3623bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3624 VK_OBJECT *obj_struct) {
3625 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003626 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003627 if (GetDisables(device_data)->destroy_image_view) return false;
3628 bool skip = false;
3629 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003630 skip |=
3631 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003632 }
3633 return skip;
3634}
3635
3636void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3637 VK_OBJECT obj_struct) {
3638 // Any bound cmd buffers are now invalid
3639 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3640 (*GetImageViewMap(device_data)).erase(image_view);
3641}
3642
3643bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3644 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003645 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003646 if (GetDisables(device_data)->destroy_buffer) return false;
3647 bool skip = false;
3648 if (*buffer_state) {
3649 skip |= validateIdleBuffer(device_data, buffer);
3650 }
3651 return skip;
3652}
3653
3654void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3655 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3656 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3657 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3658 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003659 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003660 }
3661 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003662 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003663 GetBufferMap(device_data)->erase(buffer_state->buffer);
3664}
3665
3666bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3667 VK_OBJECT *obj_struct) {
3668 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003669 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003670 if (GetDisables(device_data)->destroy_buffer_view) return false;
3671 bool skip = false;
3672 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003673 skip |=
3674 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003675 }
3676 return skip;
3677}
3678
3679void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3680 VK_OBJECT obj_struct) {
3681 // Any bound cmd buffers are now invalid
3682 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3683 GetBufferViewMap(device_data)->erase(buffer_view);
3684}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003685
3686bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3687 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003688 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003689 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003690 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003691 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3692 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003693 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003694 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003695 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003696 return skip;
3697}
3698
3699void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3700 std::function<bool()> function = [=]() {
3701 SetBufferMemoryValid(device_data, buffer_state, true);
3702 return false;
3703 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003704 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003705 // Update bindings between buffer and cmd buffer
3706 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003707}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003708
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003709bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3710 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003711 bool skip = false;
3712
3713 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003714 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3715 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003717 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003718 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
3719 "must be 0 and 1, respectively. %s",
3720 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003721 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003722 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003723 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003724
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003725 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3726 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003727 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003728 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003729 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3730 "must be 0 and 1, respectively. %s",
3731 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003732 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003733 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003734 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003735
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003736 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3737 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003739 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003740 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
3741 "%d. For 3D images these must be 0 and 1, respectively. %s",
3742 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003743 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003744 }
3745 }
3746
3747 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3748 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003749 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003750 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003751 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003752 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003753 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3754 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003755 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003756 }
3757
3758 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003759 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003760 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003761 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003762 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003763 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003764 }
3765
3766 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3767 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3768 skip |= log_msg(
3769 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003770 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003771 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3772 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003773 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003774 }
3775
3776 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3777 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3778 skip |= log_msg(
3779 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003780 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003781 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3782 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003783 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003784 }
3785
3786 // subresource aspectMask must have exactly 1 bit set
3787 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3788 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3789 if (aspect_mask_bits.count() != 1) {
3790 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003791 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003792 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003793 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003794 }
3795
3796 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003797 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003798 skip |= log_msg(
3799 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003800 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003801 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3802 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003803 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003804 }
3805
3806 // Checks that apply only to compressed images
3807 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3808 // reserves a place for these compressed image checks. This block of code could move there once the image
3809 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003810 if (FormatIsCompressed(image_state->createInfo.format)) {
3811 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003812
3813 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003814 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003815 skip |= log_msg(
3816 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003817 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003818 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003819 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003820 }
3821
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003822 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003823 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003824 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003825 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003826 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
3827 "height (%d). %s.",
3828 function, i, pRegions[i].bufferImageHeight, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003829 validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003830 }
3831
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003832 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003833 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3834 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3835 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003836 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003837 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003838 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3839 "width & height (%d, %d). %s.",
3840 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003841 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003842 }
3843
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003844 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003845 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3846 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003847 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003848 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003849 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3850 ") must be a multiple of the compressed image's texel block "
3851 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3852 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003853 validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003854 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003855
3856 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003857 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003858 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003859 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3860 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003861 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003862 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3863 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3864 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003865 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003866 }
3867
3868 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003869 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003870 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3871 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003872 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003873 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3874 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3875 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003876 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003877 }
3878
3879 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003880 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003881 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3882 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003883 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003884 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3885 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3886 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003887 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003888 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003889 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003890 }
3891
3892 return skip;
3893}
3894
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003895static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3896 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003897 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003898 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003899
3900 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003901 VkExtent3D extent = pRegions[i].imageExtent;
3902 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003903
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003904 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3905 {
3906 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3907 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3908 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3909 extent.height, extent.depth);
3910 }
3911
3912 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3913
3914 // 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 -06003915 if (FormatIsCompressed(image_info->format)) {
3916 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003917 if (image_extent.width % block_extent.width) {
3918 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3919 }
3920 if (image_extent.height % block_extent.height) {
3921 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3922 }
3923 if (image_extent.depth % block_extent.depth) {
3924 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3925 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003926 }
3927
Dave Houltonfc1a4052017-04-27 14:32:45 -06003928 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003929 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003930 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003931 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003932 }
3933 }
3934
3935 return skip;
3936}
3937
Chris Forbese8ba09a2017-06-01 17:39:02 -07003938static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003939 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3940 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003941 bool skip = false;
3942
3943 VkDeviceSize buffer_size = buff_state->createInfo.size;
3944
3945 for (uint32_t i = 0; i < regionCount; i++) {
3946 VkExtent3D copy_extent = pRegions[i].imageExtent;
3947
3948 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3949 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003950 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003951
Dave Houltonf3229d52017-02-21 15:59:08 -07003952 // Handle special buffer packing rules for specific depth/stencil formats
3953 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003954 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003955 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3956 switch (image_state->createInfo.format) {
3957 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003958 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003959 break;
3960 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003961 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003962 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003963 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003964 case VK_FORMAT_D24_UNORM_S8_UINT:
3965 unit_size = 4;
3966 break;
3967 default:
3968 break;
3969 }
3970 }
3971
Dave Houlton1d2022c2017-03-29 11:43:58 -06003972 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003973 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003974 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003975 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3976 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3977
3978 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3979 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3980 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003981 }
3982
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003983 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3984 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3985 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003986 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003987 } else {
3988 // Calculate buffer offset of final copied byte, + 1.
3989 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3990 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3991 max_buffer_offset *= unit_size; // convert to bytes
3992 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003993
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003994 if (buffer_size < max_buffer_offset) {
3995 skip |=
3996 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3997 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
3998 i, buffer_size, validation_error_map[msg_code]);
3999 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004000 }
4001 }
4002
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004003 return skip;
4004}
4005
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004006bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004007 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004008 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004009 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4010 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4011
4012 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004013 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004014
4015 // Command pool must support graphics, compute, or transfer operations
4016 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4017
4018 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4019 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4020 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004021 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004022 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
4023 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004024 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004025 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004026 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004027 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004028 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004029 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004030
4031 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004032 VALIDATION_ERROR_19200178);
4033 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
4034 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004035
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004036 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004037 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004038 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004039 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4040 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
4041 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004042 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004043 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004044 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4045 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4046 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004047 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004048 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004049 }
4050 return skip;
4051}
4052
4053void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004054 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4055 VkImageLayout src_image_layout) {
4056 // Make sure that all image slices are updated to correct layout
4057 for (uint32_t i = 0; i < region_count; ++i) {
4058 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4059 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004060 // Update bindings between buffer/image and cmd buffer
4061 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004062 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004063
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004064 std::function<bool()> function = [=]() {
4065 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4066 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004067 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004068 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004069 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004070 return false;
4071 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004072 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004073}
4074
4075bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004076 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004077 const VkBufferImageCopy *pRegions, const char *func_name) {
4078 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4079 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4080
4081 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004082 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004083
4084 // Command pool must support graphics, compute, or transfer operations
4085 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4086 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4087 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4088 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004089 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004090 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
4091 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004092 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004093 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004094 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004095 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004096 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004097 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004098 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004099 VALIDATION_ERROR_18e00166);
4100 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4101 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4102 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4103 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4104 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004105 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004106 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004107 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004108 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004109 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4110 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4111 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004112 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4113 "vkCmdCopyBufferToImage()");
4114 }
4115 return skip;
4116}
4117
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004118void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004119 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4120 VkImageLayout dst_image_layout) {
4121 // Make sure that all image slices are updated to correct layout
4122 for (uint32_t i = 0; i < region_count; ++i) {
4123 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4124 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004125 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004126 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004127 std::function<bool()> function = [=]() {
4128 SetImageMemoryValid(device_data, dst_image_state, true);
4129 return false;
4130 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004131 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004132 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004133 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004134}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004135
4136bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4137 const auto report_data = core_validation::GetReportData(device_data);
4138 bool skip = false;
4139 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4140
Dave Houlton1d960ff2018-01-19 12:17:05 -07004141 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004142 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4143 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4144 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004145 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004146 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004147 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004148 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004149 }
4150
4151 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4152 if (!image_entry) {
4153 return skip;
4154 }
4155
Dave Houlton1d960ff2018-01-19 12:17:05 -07004156 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004157 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
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),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004159 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004160 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004161 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004162 }
4163
Dave Houlton1d960ff2018-01-19 12:17:05 -07004164 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004165 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004166 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004167 __LINE__, VALIDATION_ERROR_0a4007cc, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004168 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004169 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_0a4007cc]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004170 }
4171
Dave Houlton1d960ff2018-01-19 12:17:05 -07004172 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004173 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004174 skip |=
4175 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4176 __LINE__, VALIDATION_ERROR_0a4007ce, "IMAGE",
4177 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
4178 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_0a4007ce]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004179 }
4180
Dave Houlton1d960ff2018-01-19 12:17:05 -07004181 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004182 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004183 if (FormatIsMultiplane(img_format)) {
4184 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4185 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4186 if (FormatPlaneCount(img_format) > 2u) {
4187 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4188 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4189 }
4190 if (sub_aspect != (sub_aspect & allowed_flags)) {
4191 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4192 HandleToUint64(image), __LINE__, vuid, "IMAGE",
4193 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
4194 ") must be a single-plane specifier flag. %s",
4195 sub_aspect, validation_error_map[vuid]);
4196 }
4197 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004198 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004199 skip |= log_msg(
4200 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), __LINE__,
4201 VALIDATION_ERROR_0a400c01, "IMAGE",
4202 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
4203 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004204 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004205 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004206 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004207 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004208 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004209 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
4210 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004211 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004212 }
4213 }
4214 return skip;
4215}