blob: de32cb20afc8636599b2e443968286aac829831b [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}
623
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
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600637 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600638
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600639 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties.linearTilingFeatures == 0)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600640 std::stringstream ss;
641 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600642 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 -0600643 VALIDATION_ERROR_09e007a2, "IMAGE", "%s. %s", ss.str().c_str(),
644 validation_error_map[VALIDATION_ERROR_09e007a2]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600645
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600646 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600647 }
648
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600649 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties.optimalTilingFeatures == 0)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600650 std::stringstream ss;
651 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600652 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 -0600653 VALIDATION_ERROR_09e007ac, "IMAGE", "%s. %s", ss.str().c_str(),
654 validation_error_map[VALIDATION_ERROR_09e007ac]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600655
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600656 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600657 }
658
Lenny Komowb79f04a2017-09-18 17:07:00 -0600659 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
660 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
661 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
662 // Validate that format supports usage as color attachment
663 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
664 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
665 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
666 std::stringstream ss;
667 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
668 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
669 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
670 VALIDATION_ERROR_09e007b2, "IMAGE", "%s. %s", ss.str().c_str(),
671 validation_error_map[VALIDATION_ERROR_09e007b2]);
672 }
673 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
674 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
675 std::stringstream ss;
676 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
677 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
678 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
679 VALIDATION_ERROR_09e007a8, "IMAGE", "%s. %s", ss.str().c_str(),
680 validation_error_map[VALIDATION_ERROR_09e007a8]);
681 }
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
685 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
686 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
687 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
688 std::stringstream ss;
689 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
690 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
691 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
692 VALIDATION_ERROR_09e007b4, "IMAGE", "%s. %s", ss.str().c_str(),
693 validation_error_map[VALIDATION_ERROR_09e007b4]);
694 }
695 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
696 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
697 std::stringstream ss;
698 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
699 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
700 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
701 VALIDATION_ERROR_09e007aa, "IMAGE", "%s. %s", ss.str().c_str(),
702 validation_error_map[VALIDATION_ERROR_09e007aa]);
703 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600704 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700705 }
706
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600707 VkImageFormatProperties ImageFormatProperties = GetImageFormatProperties(
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700708 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700709
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700710 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700711 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700712
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600713 // TODO: VALIDATION_ERROR_09e00770 VALIDATION_ERROR_09e00772 VALIDATION_ERROR_09e00776 VALIDATION_ERROR_09e0076e
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700714 // All these extent-related VUs should be checked here
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600715 if ((pCreateInfo->extent.depth > ImageFormatProperties.maxExtent.depth) ||
716 (pCreateInfo->extent.width > ImageFormatProperties.maxExtent.width) ||
717 (pCreateInfo->extent.height > ImageFormatProperties.maxExtent.height)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600718 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
719 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
720 "CreateImage extents exceed allowable limits for format: "
721 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
722 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600723 ImageFormatProperties.maxExtent.width, ImageFormatProperties.maxExtent.height,
724 ImageFormatProperties.maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700725 }
726
Dave Houlton1150cf52017-04-27 14:38:11 -0600727 uint64_t totalSize =
728 ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height * (uint64_t)pCreateInfo->extent.depth *
729 (uint64_t)pCreateInfo->arrayLayers * (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format) +
730 (uint64_t)imageGranularity) &
731 ~(uint64_t)imageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700732
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600733 if (totalSize > ImageFormatProperties.maxResourceSize) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600734 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
735 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
736 "CreateImage resource size exceeds allowable maximum "
737 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600738 totalSize, ImageFormatProperties.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700739 }
740
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600741 // TODO: VALIDATION_ERROR_09e0077e
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600742 if (pCreateInfo->mipLevels > ImageFormatProperties.maxMipLevels) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600743 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
744 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
745 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600746 ImageFormatProperties.maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700747 }
748
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600749 if (pCreateInfo->arrayLayers > ImageFormatProperties.maxArrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600750 skip |=
751 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
752 VALIDATION_ERROR_09e00780, "Image",
753 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600754 ImageFormatProperties.maxArrayLayers, validation_error_map[VALIDATION_ERROR_09e00780]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700755 }
756
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600757 if ((pCreateInfo->samples & ImageFormatProperties.sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600758 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 -0600759 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600760 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties.sampleCounts,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600761 validation_error_map[VALIDATION_ERROR_09e0078e]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700762 }
763
764 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600765 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 -0600766 VALIDATION_ERROR_09e0b801, "Image",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600767 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
768 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600769 validation_error_map[VALIDATION_ERROR_09e0b801]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700770 }
771
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600772 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600773 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 -0600774 VALIDATION_ERROR_09e00792, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600775 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
776 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600777 validation_error_map[VALIDATION_ERROR_09e00792]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600778 }
779
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600780 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600781 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
782 DRAWSTATE_INVALID_FEATURE, "DS",
783 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
784 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600785 }
786
Lenny Komowb79f04a2017-09-18 17:07:00 -0600787 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
788 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
789 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
790 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
791 // TODO: Add Maintenance2 VUID
792 skip |=
793 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
794 VALIDATION_ERROR_UNDEFINED, "DS",
795 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
796 "format must be block, ETC or ASTC compressed, but is %s",
797 string_VkFormat(pCreateInfo->format));
798 }
799 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
800 // TODO: Add Maintenance2 VUID
801 skip |=
802 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
803 VALIDATION_ERROR_UNDEFINED, "DS",
804 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
805 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
806 }
807 }
808 }
809
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600810 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700811}
812
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700813void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700814 IMAGE_LAYOUT_NODE image_state;
815 image_state.layout = pCreateInfo->initialLayout;
816 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700817 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 -0700818 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700819 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
820 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700821}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700822
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700823bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700824 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700825 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200826 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700827 if (disabled->destroy_image) return false;
828 bool skip = false;
829 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600830 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
831 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700832 }
833 return skip;
834}
835
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700836void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700837 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
838 // Clean up memory mapping, bindings and range references for image
839 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700840 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700841 if (mem_info) {
842 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
843 }
844 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600845 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700846 // Remove image from imageMap
847 core_validation::GetImageMap(device_data)->erase(image);
848 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
849 core_validation::GetImageSubresourceMap(device_data);
850
851 const auto &sub_entry = imageSubresourceMap->find(image);
852 if (sub_entry != imageSubresourceMap->end()) {
853 for (const auto &pair : sub_entry->second) {
854 core_validation::GetImageLayoutMap(device_data)->erase(pair);
855 }
856 imageSubresourceMap->erase(sub_entry);
857 }
858}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700859
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700860bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700861 bool skip = false;
862 const debug_report_data *report_data = core_validation::GetReportData(device_data);
863
864 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
865 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
866 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 +0200867 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700868 }
869
Dave Houlton1d2022c2017-03-29 11:43:58 -0600870 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700871 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
872 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 -0600873 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
874 validation_error_map[VALIDATION_ERROR_1880000e]);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600875 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700876 char const str[] = "vkCmdClearColorImage called with compressed image.";
877 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 -0600878 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
879 validation_error_map[VALIDATION_ERROR_1880000e]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700880 }
881
882 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
883 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
884 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 -0600885 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s. %s", str,
886 validation_error_map[VALIDATION_ERROR_18800004]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700887 }
888 return skip;
889}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700890
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600891uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
892 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
893 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700894 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600895 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700896 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600897 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700898}
899
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600900uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
901 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
902 uint32_t array_layer_count = range->layerCount;
903 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
904 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700905 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600906 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700907}
908
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700909bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700910 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
911 bool skip = false;
912 const debug_report_data *report_data = core_validation::GetReportData(device_data);
913
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600914 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
915 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700916
917 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
918 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700919 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
920 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600921 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 +0200922 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700923 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
924 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600925 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600926 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600927 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600928 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 -0600929 HandleToUint64(image_state->image), __LINE__, 0, "DS",
930 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
931 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600932
933 } else {
934 if (image_state->shared_presentable) {
935 skip |= log_msg(
936 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600937 HandleToUint64(image_state->image), __LINE__, 0, "DS",
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600938 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
939 string_VkImageLayout(dest_image_layout));
940 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600941 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700942 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600943 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700944 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600945 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700946 } else {
947 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
948 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600949 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 +0200950 HandleToUint64(image_state->image), __LINE__, error_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600951 "%s: Layout for cleared image is %s but can only be "
952 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
953 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700954 }
955 }
956
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600957 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
958 uint32_t level = level_index + range.baseMipLevel;
959 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
960 uint32_t layer = layer_index + range.baseArrayLayer;
961 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700962 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700963 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700964 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600965 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700966 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600967 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700968 } else {
969 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
970 }
971 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
972 __LINE__, error_code, "DS",
973 "%s: Cannot clear an image whose layout is %s and "
974 "doesn't match the current layout %s. %s",
975 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
976 validation_error_map[error_code]);
977 }
978 }
979 }
980 }
981
982 return skip;
983}
984
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700985void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
986 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600987 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
988 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
989 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700990
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600991 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
992 uint32_t level = level_index + range.baseMipLevel;
993 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
994 uint32_t layer = layer_index + range.baseArrayLayer;
995 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700996 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700997 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
998 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 -0700999 }
1000 }
1001 }
1002}
1003
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001004bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001005 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1006 bool skip = false;
1007 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001008 auto cb_node = GetCBNode(dev_data, commandBuffer);
1009 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001010 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001011 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001012 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001013 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001014 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001015 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001016 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001017 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001018 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001019 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001020 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001021 }
1022 }
1023 return skip;
1024}
1025
1026// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001027void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001028 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001029 auto cb_node = GetCBNode(dev_data, commandBuffer);
1030 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001031 if (cb_node && image_state) {
1032 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1033 std::function<bool()> function = [=]() {
1034 SetImageMemoryValid(dev_data, image_state, true);
1035 return false;
1036 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001037 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001038 for (uint32_t i = 0; i < rangeCount; ++i) {
1039 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1040 }
1041 }
1042}
1043
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001044bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1045 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001046 const VkImageSubresourceRange *pRanges) {
1047 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001048 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1049
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001050 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001051 auto cb_node = GetCBNode(device_data, commandBuffer);
1052 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001053 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001054 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001055 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001056 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001057 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001058 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001059 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001060 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001061 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001062 skip |=
1063 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001064 // Image aspect must be depth or stencil or both
1065 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1066 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1067 char const str[] =
1068 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
1069 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
1070 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 +02001071 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001072 }
1073 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001074 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001075 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001076 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1077 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s. %s", str,
1078 validation_error_map[VALIDATION_ERROR_18a0001c]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001079 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001080 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1081 char const str[] =
1082 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1083 "set.";
1084 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1085 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00012, "IMAGE", "%s. %s", str,
1086 validation_error_map[VALIDATION_ERROR_18a00012]);
1087 }
1088 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1089 VkImageTiling tiling = image_state->createInfo.tiling;
1090 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1091 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1092 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
1093 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1094 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00010, "IMAGE",
1095 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1096 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR. %s",
1097 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling),
1098 validation_error_map[VALIDATION_ERROR_18a00010]);
1099 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001100 }
1101 return skip;
1102}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001103
1104// Returns true if [x, xoffset] and [y, yoffset] overlap
1105static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1106 bool result = false;
1107 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1108 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1109
1110 if (intersection_max > intersection_min) {
1111 result = true;
1112 }
1113 return result;
1114}
1115
1116// Returns true if two VkImageCopy structures overlap
1117static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1118 bool result = false;
1119 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1120 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1121 dst->dstSubresource.layerCount))) {
1122 result = true;
1123 switch (type) {
1124 case VK_IMAGE_TYPE_3D:
1125 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1126 // Intentionally fall through to 2D case
1127 case VK_IMAGE_TYPE_2D:
1128 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1129 // Intentionally fall through to 1D case
1130 case VK_IMAGE_TYPE_1D:
1131 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1132 break;
1133 default:
1134 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1135 assert(false);
1136 }
1137 }
1138 return result;
1139}
1140
Dave Houltonfc1a4052017-04-27 14:32:45 -06001141// Returns non-zero if offset and extent exceed image extents
1142static const uint32_t x_bit = 1;
1143static const uint32_t y_bit = 2;
1144static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001145static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001146 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001147 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001148 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1149 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001150 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001151 }
1152 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1153 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001154 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001155 }
1156 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1157 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001158 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001159 }
1160 return result;
1161}
1162
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001163// Test if two VkExtent3D structs are equivalent
1164static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1165 bool result = true;
1166 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1167 (extent->depth != other_extent->depth)) {
1168 result = false;
1169 }
1170 return result;
1171}
1172
Dave Houltonee281a52017-12-08 13:51:02 -07001173// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1174// Destination image texel extents must be adjusted by block size for the dest validation checks
1175VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1176 VkExtent3D adjusted_extent = extent;
1177 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
1178 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_format);
1179 adjusted_extent.width /= block_size.width;
1180 adjusted_extent.height /= block_size.height;
1181 adjusted_extent.depth /= block_size.depth;
1182 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
1183 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_format);
1184 adjusted_extent.width *= block_size.width;
1185 adjusted_extent.height *= block_size.height;
1186 adjusted_extent.depth *= block_size.depth;
1187 }
1188 return adjusted_extent;
1189}
1190
Dave Houlton6f9059e2017-05-02 17:15:13 -06001191// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001192static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1193 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001194
1195 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001196 if (mip >= img->createInfo.mipLevels) {
1197 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001198 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001199
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001200 // 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 -06001201 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001202 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1203 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1204 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001205
Dave Houlton6f9059e2017-05-02 17:15:13 -06001206 // Image arrays have an effective z extent that isn't diminished by mip level
1207 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001208 extent.depth = img->createInfo.arrayLayers;
1209 }
1210
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001211 return extent;
1212}
1213
1214// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001215static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001216 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1217}
1218
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001219// Test if the extent argument has any dimensions set to 0.
1220static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1221 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1222}
1223
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001224// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1225static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1226 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1227 VkExtent3D granularity = {0, 0, 0};
1228 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1229 if (pPool) {
1230 granularity =
1231 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001232 if (FormatIsCompressed(img->createInfo.format)) {
1233 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001234 granularity.width *= block_size.width;
1235 granularity.height *= block_size.height;
1236 }
1237 }
1238 return granularity;
1239}
1240
1241// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1242static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1243 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001244 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1245 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001246 valid = false;
1247 }
1248 return valid;
1249}
1250
1251// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1252static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1253 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1254 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1255 bool skip = false;
1256 VkExtent3D offset_extent = {};
1257 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1258 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1259 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001260 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001261 // 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 -07001262 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001263 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1264 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1265 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1266 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1267 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001268 }
1269 } else {
1270 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1271 // integer multiples of the image transfer granularity.
1272 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001273 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1274 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1275 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1276 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1277 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1278 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001279 }
1280 }
1281 return skip;
1282}
1283
1284// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1285static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1286 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001287 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001288 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1289 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001290 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001291 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1292 // subresource extent.
1293 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001294 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1295 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1296 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1297 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1298 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1299 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001300 }
1301 } else {
1302 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1303 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1304 // subresource extent dimensions.
1305 VkExtent3D offset_extent_sum = {};
1306 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1307 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1308 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001309 bool x_ok = true;
1310 bool y_ok = true;
1311 bool z_ok = true;
1312 switch (image_type) {
1313 case VK_IMAGE_TYPE_3D:
1314 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1315 (subresource_extent->depth == offset_extent_sum.depth));
1316 // Intentionally fall through to 2D case
1317 case VK_IMAGE_TYPE_2D:
1318 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1319 (subresource_extent->height == offset_extent_sum.height));
1320 // Intentionally fall through to 1D case
1321 case VK_IMAGE_TYPE_1D:
1322 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1323 (subresource_extent->width == offset_extent_sum.width));
1324 break;
1325 default:
1326 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1327 assert(false);
1328 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001329 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001330 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001331 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 +02001332 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001333 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1334 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1335 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1336 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1337 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1338 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1339 }
1340 }
1341 return skip;
1342}
1343
1344// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1345static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1346 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1347 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1348
1349 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001350 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001351 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 +02001352 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001353 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1354 "transfer granularity width (%d).",
1355 function, i, member, value, granularity);
1356 }
1357 return skip;
1358}
1359
1360// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1361static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1362 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1363 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1364 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001365 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001366 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 +02001367 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001368 "%s: pRegion[%d].%s (%" PRIdLEAST64
1369 ") must be an even integer multiple of this command buffer's queue family image transfer "
1370 "granularity width (%d).",
1371 function, i, member, value, granularity);
1372 }
1373 return skip;
1374}
1375
1376// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1377bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1378 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1379 const uint32_t i, const char *function) {
1380 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001381 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001382 // TODO: Add granularity checking for compressed formats
1383
1384 // bufferRowLength must be a multiple of the compressed texel block width
1385 // bufferImageHeight must be a multiple of the compressed texel block height
1386 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1387 // bufferOffset must be a multiple of the compressed texel block size in bytes
1388 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1389 // must equal the image subresource width
1390 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1391 // must equal the image subresource height
1392 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1393 // must equal the image subresource depth
1394 } else {
1395 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1396 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1397 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1398 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1399 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1400 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1401 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001402 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001403 }
1404 return skip;
1405}
1406
1407// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1408bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001409 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1410 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001411 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001412 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001413 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001414 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001415 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07001416 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001417 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001418 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001419
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001420 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001421 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001422 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houltonee281a52017-12-08 13:51:02 -07001423 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07001424 const VkExtent3D dest_effective_extent =
1425 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001426 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07001427 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001428 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001429 return skip;
1430}
1431
Dave Houlton6f9059e2017-05-02 17:15:13 -06001432// Validate contents of a VkImageCopy struct
1433bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1434 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1435 bool skip = false;
1436
1437 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001438 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001439
1440 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07001441 const VkExtent3D src_copy_extent = region.extent;
1442 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07001443 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
1444
Dave Houlton6f9059e2017-05-02 17:15:13 -06001445 bool slice_override = false;
1446 uint32_t depth_slices = 0;
1447
1448 // Special case for copying between a 1D/2D array and a 3D image
1449 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1450 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001451 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001452 slice_override = (depth_slices != 1);
1453 } 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 -07001454 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001455 slice_override = (depth_slices != 1);
1456 }
1457
1458 // Do all checks on source image
1459 //
1460 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001461 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
1462 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1463 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1464 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1465 "be 0 and 1, respectively. %s",
1466 i, region.srcOffset.y, src_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001467 }
1468 }
1469
1470 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (src_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001471 if ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth)) {
1472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1473 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00128, "IMAGE",
1474 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1475 "these must be 0 and 1, respectively. %s",
1476 i, region.srcOffset.z, src_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00128]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001477 }
1478 }
1479
1480 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001481 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001482 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001483 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001484 skip |=
1485 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001486 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001487 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1488 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001489 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001490 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001491 }
1492 }
1493 } else { // Pre maint 1
1494 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001495 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001496 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1497 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1498 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1499 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1500 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001501 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001502 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001503 }
1504 }
1505 }
1506
1507 // 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 -07001508 if ((region.srcSubresource.baseArrayLayer >= src_state->createInfo.arrayLayers) ||
1509 (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount > src_state->createInfo.arrayLayers)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001510 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 +01001511 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0012a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001512 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer (%d) must be less than the source image's "
1513 "arrayLayers (%d), and the sum of baseArrayLayer and srcSubresource.layerCount (%d) must be less than "
1514 "or equal to the source image's arrayLayers. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001515 i, region.srcSubresource.baseArrayLayer, src_state->createInfo.arrayLayers,
1516 region.srcSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c0012a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001517 }
1518
1519 // Checks that apply only to compressed images
1520 if (FormatIsCompressed(src_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001521 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001522
1523 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001524 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
1525 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
1526 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001527 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 +01001528 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001529 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1530 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001531 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001532 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001533 }
1534
Dave Houlton94a00372017-12-14 15:08:47 -07001535 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001536 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
1537 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001538 skip |=
1539 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001540 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001541 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1542 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001543 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001544 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001545 }
1546
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001547 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07001548 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
1549 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001550 skip |=
1551 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001552 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001553 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1554 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001555 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001556 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001557 }
1558
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001559 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07001560 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
1561 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001562 skip |=
1563 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001564 HandleToUint64(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001565 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1566 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001567 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001568 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001569 }
1570 } // Compressed
1571
1572 // Do all checks on dest image
1573 //
1574 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001575 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
1576 skip |= log_msg(
1577 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1578 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1579 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images these must "
1580 "be 0 and 1, respectively. %s",
1581 i, region.dstOffset.y, dst_copy_extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001582 }
1583 }
1584
1585 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001586 if ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001587 skip |=
1588 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001589 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00134, "IMAGE",
Dave Houltonee281a52017-12-08 13:51:02 -07001590 "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 -06001591 "these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001592 i, region.dstOffset.z, dst_copy_extent.depth, validation_error_map[VALIDATION_ERROR_09c00134]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001593 }
1594 }
1595
1596 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001597 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001598 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001599 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001600 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1601 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001602 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001603 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001604 }
1605 }
1606 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001607 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001608 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001609 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001610 skip |=
1611 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Kraus13c98a62017-12-09 00:22:39 +01001612 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001613 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1614 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001615 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001616 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001617 }
1618 }
1619 } else { // Pre maint 1
1620 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07001621 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01001622 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1623 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1624 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1625 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1626 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001627 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount,
Petr Kraus13c98a62017-12-09 00:22:39 +01001628 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001629 }
1630 }
1631 }
1632
1633 // 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 -07001634 if ((region.dstSubresource.baseArrayLayer >= dst_state->createInfo.arrayLayers) ||
1635 (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount > dst_state->createInfo.arrayLayers)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001636 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 +01001637 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00136, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001638 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer (%d) must be less than the dest image's "
1639 "arrayLayers (%d), and the sum of baseArrayLayer and dstSubresource.layerCount (%d) must be less than "
1640 "or equal to the dest image's arrayLayers. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001641 i, region.dstSubresource.baseArrayLayer, dst_state->createInfo.arrayLayers,
1642 region.dstSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c00136]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001643 }
1644
1645 // Checks that apply only to compressed images
1646 if (FormatIsCompressed(dst_state->createInfo.format)) {
Dave Houlton94a00372017-12-14 15:08:47 -07001647 const VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001648
1649 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07001650 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
1651 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
1652 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001653 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 +01001654 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001655 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1656 "texel width & height (%d, %d). %s.",
Dave Houltonee281a52017-12-08 13:51:02 -07001657 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001658 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001659 }
1660
Dave Houlton94a00372017-12-14 15:08:47 -07001661 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07001662 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
1663 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
1664 skip |= log_msg(
1665 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1666 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
1667 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture block "
1668 "width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
1669 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width,
1670 validation_error_map[VALIDATION_ERROR_09c00146]);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001671 }
1672
Dave Houltonee281a52017-12-08 13:51:02 -07001673 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
1674 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
1675 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
1676 skip |= log_msg(
1677 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1678 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
1679 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed texture block "
1680 "height (%d), or when added to dstOffset.y (%d) must equal the image subresource height (%d). %s.",
1681 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height,
1682 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001683 }
1684
Dave Houltonee281a52017-12-08 13:51:02 -07001685 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
1686 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
1687 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
1688 skip |= log_msg(
1689 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1690 HandleToUint64(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
1691 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture block "
1692 "depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1693 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth,
1694 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001695 }
1696 } // Compressed
1697 }
1698 return skip;
1699}
1700
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001701bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001702 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1703 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001704 bool skip = false;
1705 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001706 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1707
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001708 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1709
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001710 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07001711 const VkImageCopy region = regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07001712
1713 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
1714 VkExtent3D src_copy_extent = region.extent;
1715 VkExtent3D dst_copy_extent =
1716 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
1717
Dave Houlton6f9059e2017-05-02 17:15:13 -06001718 bool slice_override = false;
1719 uint32_t depth_slices = 0;
1720
1721 // Special case for copying between a 1D/2D array and a 3D image
1722 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1723 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1724 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001725 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001726 slice_override = (depth_slices != 1);
1727 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1728 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07001729 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06001730 slice_override = (depth_slices != 1);
1731 }
1732
Dave Houltonee281a52017-12-08 13:51:02 -07001733 if (region.srcSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001734 std::stringstream ss;
1735 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001736 skip |=
1737 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1738 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001739 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001740
Dave Houltonee281a52017-12-08 13:51:02 -07001741 if (region.dstSubresource.layerCount == 0) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001742 std::stringstream ss;
1743 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001744 skip |=
1745 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1746 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001747 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001748
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001749 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001750 // No chance of mismatch if we're overriding depth slice count
1751 if (!slice_override) {
1752 // The number of depth slices in srcSubresource and dstSubresource must match
1753 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1754 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001755 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
1756 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001757 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07001758 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
1759 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001760 if (src_slices != dst_slices) {
1761 std::stringstream ss;
1762 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1763 << "] do not match";
1764 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 +01001765 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1766 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001767 }
1768 }
1769 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001770 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001771 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001772 std::stringstream ss;
1773 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1774 << "] do not match";
1775 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 -06001776 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1777 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001778 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001779 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001780
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001781 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07001782 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001783 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1784 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 -06001785 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1786 validation_error_map[VALIDATION_ERROR_09c00112]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001787 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001788
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001789 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07001790 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001791 std::stringstream ss;
1792 ss << "vkCmdCopyImage: pRegion[" << i
1793 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1794 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 -06001795 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1796 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001797 }
1798
1799 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07001800 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001801 std::stringstream ss;
1802 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1803 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 -06001804 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1805 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001806 }
1807
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001808 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001809 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1810 (region.dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001811 std::stringstream ss;
1812 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1813 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 -06001814 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1815 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001816 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001817
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001818 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1819 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Dave Houltonee281a52017-12-08 13:51:02 -07001820 if ((region.srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1821 (region.srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001822 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1823 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 -06001824 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s. %s", str,
1825 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001826 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001827
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001828 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001829 if (region.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001830 std::stringstream ss;
1831 ss << "vkCmdCopyImage: pRegions[" << i
1832 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1833 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 -06001834 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1835 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001836 }
Dave Houltonee281a52017-12-08 13:51:02 -07001837 if (region.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001838 std::stringstream ss;
1839 ss << "vkCmdCopyImage: pRegions[" << i
1840 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1841 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 -06001842 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1843 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001844 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001845
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001846 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1847 // image was created
Dave Houltonee281a52017-12-08 13:51:02 -07001848 if ((region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount) > src_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001849 std::stringstream ss;
1850 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001851 << "] baseArrayLayer + layerCount is " << (region.srcSubresource.baseArrayLayer + region.srcSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001852 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 -06001853 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1854 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001855 }
Dave Houltonee281a52017-12-08 13:51:02 -07001856 if ((region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount) > dst_image_state->createInfo.arrayLayers) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001857 std::stringstream ss;
1858 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
Dave Houltonee281a52017-12-08 13:51:02 -07001859 << "] baseArrayLayer + layerCount is " << (region.dstSubresource.baseArrayLayer + region.dstSubresource.layerCount);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001860 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 -06001861 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1862 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001863 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001864
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001865 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1866 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1867 // 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 -07001868 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1869 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001870 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001871 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
1872 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
1873 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
1874 << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001875 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 -06001876 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s. %s",
1877 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001878 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001879
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001880 // 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 -07001881 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1882 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001883 std::stringstream ss;
Dave Houltonee281a52017-12-08 13:51:02 -07001884 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
1885 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
1886 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
1887 << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001888 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 -06001889 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1890 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001891 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001892 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001893
Dave Houltonfc1a4052017-04-27 14:32:45 -06001894 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07001895 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
1896 if (slice_override) src_copy_extent.depth = depth_slices;
1897 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001898 if (extent_check & x_bit) {
1899 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 -06001900 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001901 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1902 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001903 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001904 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001905 }
1906
1907 if (extent_check & y_bit) {
1908 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_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001910 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1911 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001912 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001913 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001914 }
1915 if (extent_check & z_bit) {
1916 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_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001918 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1919 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001920 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001921 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001922 }
1923
Dave Houltonee281a52017-12-08 13:51:02 -07001924 // Adjust dest extent if necessary
1925 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
1926 if (slice_override) dst_copy_extent.depth = depth_slices;
1927
1928 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001929 if (extent_check & x_bit) {
1930 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 -06001931 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001932 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1933 "width [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001934 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001935 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001936 }
1937 if (extent_check & y_bit) {
1938 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 -06001939 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001940 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1941 "height [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001942 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001943 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001944 }
1945 if (extent_check & z_bit) {
1946 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 -06001947 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001948 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1949 "depth [%1d]. %s",
Dave Houltonee281a52017-12-08 13:51:02 -07001950 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001951 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001952 }
1953
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001954 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1955 // must not overlap in memory
1956 if (src_image_state->image == dst_image_state->image) {
1957 for (uint32_t j = 0; j < region_count; j++) {
Dave Houltonee281a52017-12-08 13:51:02 -07001958 if (RegionIntersects(&region, &regions[j], src_image_state->createInfo.imageType)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001959 std::stringstream ss;
1960 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1961 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 -06001962 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
1963 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001964 }
1965 }
1966 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001967 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001968
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001969 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1970 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1971 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06001972 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001973 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1974 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02001975 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1976 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001977 }
1978 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06001979 size_t srcSize = FormatSize(src_image_state->createInfo.format);
1980 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001981 if (srcSize != destSize) {
1982 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1983 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 -06001984 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
1985 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001986 }
1987 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001988
Dave Houlton33c22b72017-02-28 13:16:02 -07001989 // Source and dest image sample counts must match
1990 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
1991 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
1992 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 -06001993 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
1994 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07001995 }
1996
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001997 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
1998 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001999 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002000 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002001 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002002 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002003 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002004 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002005 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002007 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002008 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002009 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002010 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002011 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002012 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002013 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002014 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2015 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002016 }
2017
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002018 return skip;
2019}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002020
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002021void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002022 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2023 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2024 // Make sure that all image slices are updated to correct layout
2025 for (uint32_t i = 0; i < region_count; ++i) {
2026 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2027 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2028 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002029 // Update bindings between images and cmd buffer
2030 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2031 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002032 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002033 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 function = [=]() {
2035 SetImageMemoryValid(device_data, dst_image_state, true);
2036 return false;
2037 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002038 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002039}
2040
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002041// Returns true if sub_rect is entirely contained within rect
2042static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2043 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2044 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2045 return false;
2046 return true;
2047}
2048
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002049bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2050 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002051 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002052 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2053
2054 bool skip = false;
2055 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002056 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2057 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002058 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002059 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002060 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002061 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2062 // 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 -07002063 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2064 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002065 skip |=
2066 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 +02002067 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +01002068 "vkCmdClearAttachments() issued on command buffer object 0x%" PRIx64
2069 " prior to any Draw Cmds."
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002070 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
Petr Kraus13c98a62017-12-09 00:22:39 +01002071 HandleToUint64(commandBuffer));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002072 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002073 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002074 }
2075
2076 // Validate that attachment is in reference list of active subpass
2077 if (cb_node->activeRenderPass) {
2078 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2079 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002080 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002081
2082 for (uint32_t i = 0; i < attachmentCount; i++) {
2083 auto clear_desc = &pAttachments[i];
2084 VkImageView image_view = VK_NULL_HANDLE;
2085
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002086 if (0 == clear_desc->aspectMask) {
2087 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 -06002088 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2089 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002090 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2091 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 -06002092 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2093 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002094 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002095 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002096 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2097 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2098 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2099 clear_desc->colorAttachment, cb_node->activeSubpass,
2100 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002101 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2102 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002103 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2104 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002105 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2106 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002107 } else {
2108 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002109 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002110 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002111 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2112 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2113 char const str[] =
2114 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
2115 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 -06002116 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2117 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002118 }
2119 } else { // Must be depth and/or stencil
2120 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2121 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2122 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
2123 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 -06002124 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2125 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002126 }
2127 if (!subpass_desc->pDepthStencilAttachment ||
2128 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2129 skip |= log_msg(
2130 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002131 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002132 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002133 } else {
2134 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2135 }
2136 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002137 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002138 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002139 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002140 // The rectangular region specified by a given element of pRects must be contained within the render area of
2141 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002142 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
2143 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
2144 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002145 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 -06002146 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002147 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2148 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002149 j, validation_error_map[VALIDATION_ERROR_18600020]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002150 }
2151 // The layers specified by a given element of pRects must be contained within every attachment that
2152 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002153 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002154 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2155 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002156 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002157 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 -06002158 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002159 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
2160 "pAttachment[%d]. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002161 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002162 }
2163 }
2164 }
2165 }
2166 }
2167 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002168}
2169
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002170bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002171 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002172 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002173 bool skip = false;
2174 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002175 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2176 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2177 skip |=
2178 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002179 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002180 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002181
2182 // For each region, the number of layers in the image subresource should not be zero
2183 // For each region, src and dest image aspect must be color only
2184 for (uint32_t i = 0; i < regionCount; i++) {
2185 if (pRegions[i].srcSubresource.layerCount == 0) {
2186 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002187 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 +02002188 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002189 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002190 if (pRegions[i].dstSubresource.layerCount == 0) {
2191 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002192 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 +02002193 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002194 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002195 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2196 skip |= log_msg(
2197 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002198 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002199 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002200 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002201 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002202 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2203 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2204 char const str[] =
2205 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2206 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 -06002207 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2208 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002209 }
2210 }
2211
2212 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2213 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002214 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 +02002215 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002216 }
2217 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2218 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002219 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 +02002220 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002221 }
2222 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2223 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2224 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 -06002225 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2226 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002227 }
2228 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2229 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2230 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 -06002231 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2232 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002233 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002234 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002235 } else {
2236 assert(0);
2237 }
2238 return skip;
2239}
2240
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002241void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2242 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002243 // Update bindings between images and cmd buffer
2244 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2245 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2246
2247 std::function<bool()> function = [=]() {
2248 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2249 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002250 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002251 function = [=]() {
2252 SetImageMemoryValid(device_data, dst_image_state, true);
2253 return false;
2254 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002255 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002256}
2257
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002258bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002259 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2260 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002261 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2262
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002263 bool skip = false;
2264 if (cb_node && src_image_state && dst_image_state) {
2265 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002266 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002267 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002268 VALIDATION_ERROR_184001d4);
2269 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2270 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2271 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2272 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2273 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2274 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2275 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002276 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002277 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002278 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002279
Dave Houlton33c2d252017-06-09 17:08:32 -06002280 VkFormat src_format = src_image_state->createInfo.format;
2281 VkFormat dst_format = dst_image_state->createInfo.format;
2282 VkImageType src_type = src_image_state->createInfo.imageType;
2283 VkImageType dst_type = dst_image_state->createInfo.imageType;
2284
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002285 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002286 VkImageTiling tiling = src_image_state->createInfo.tiling;
2287 VkFormatFeatureFlags flags =
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002288 (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002289 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2291 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2292 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2293 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2294 }
2295
2296 if ((VK_FILTER_LINEAR == filter) &&
2297 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2298 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2299 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2300 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2301 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2302 }
2303
2304 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2305 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
2306 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2307 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2308 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2309 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2310 }
2311
2312 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2313 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2314 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2315 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2316 validation_error_map[VALIDATION_ERROR_184001da]);
2317 }
2318
2319 props = GetFormatProperties(device_data, dst_format);
2320 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002321 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002322 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2323 skip |=
2324 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2325 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2326 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2327 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2328 }
2329
2330 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2331 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2332 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2333 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2334 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2335 validation_error_map[VALIDATION_ERROR_184001c8]);
2336 }
2337
2338 // Validate consistency for unsigned formats
2339 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2340 std::stringstream ss;
2341 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2342 << "the other one must also have unsigned integer format. "
2343 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2344 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2345 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2346 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2347 }
2348
2349 // Validate consistency for signed formats
2350 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2351 std::stringstream ss;
2352 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2353 << "the other one must also have signed integer format. "
2354 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2356 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2357 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2358 }
2359
2360 // Validate filter for Depth/Stencil formats
2361 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2362 std::stringstream ss;
2363 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2364 << "then filter must be VK_FILTER_NEAREST.";
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_184001d0, "IMAGE", "%s. %s",
2367 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2368 }
2369
2370 // Validate aspect bits and formats for depth/stencil images
2371 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2372 if (src_format != dst_format) {
2373 std::stringstream ss;
2374 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2375 << "stencil, the other one must have exactly the same format. "
2376 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2377 << string_VkFormat(dst_format);
2378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2379 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2380 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2381 }
2382
2383#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2384 for (uint32_t i = 0; i < regionCount; i++) {
2385 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2386
2387 if (FormatIsDepthAndStencil(src_format)) {
2388 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2389 std::stringstream ss;
2390 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
2391 "VK_IMAGE_ASPECT_DEPTH_BIT "
2392 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2393 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2394 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2395 "%s", ss.str().c_str());
2396 }
2397 }
2398 else if (FormatIsStencilOnly(src_format)) {
2399 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2400 std::stringstream ss;
2401 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2402 << "set in both the srcImage and dstImage";
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__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2405 "%s", ss.str().c_str());
2406 }
2407 }
2408 else if (FormatIsDepthOnly(src_format)) {
2409 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2410 std::stringstream ss;
2411 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2412 << "set in both the srcImage and dstImage";
2413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2414 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2415 "%s", ss.str().c_str());
2416 }
2417 }
2418 }
2419#endif
2420 } // Depth or Stencil
2421
2422 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002423 for (uint32_t i = 0; i < region_count; i++) {
2424 const VkImageBlit rgn = regions[i];
2425 bool hit_error = false;
2426 skip |=
2427 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2428 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2429 skip |=
2430 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2431 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002432
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002433 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002434 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2435 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002436 std::stringstream ss;
2437 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2438 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 +02002439 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2440 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002441 }
Dave Houlton48989f32017-05-26 15:01:46 -06002442 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2443 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002444 std::stringstream ss;
2445 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2446 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 +02002447 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2448 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002449 }
Dave Houlton48989f32017-05-26 15:01:46 -06002450 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002451 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2452 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 +02002453 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002454 }
Dave Houlton48989f32017-05-26 15:01:46 -06002455 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002456 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2457 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 +02002458 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002459 }
2460
2461 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002462 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002463 skip |=
2464 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 -06002465 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002466 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002467 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002468 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002469
Dave Houlton48989f32017-05-26 15:01:46 -06002470 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002471 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 -06002472 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002473 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002474 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002475 }
Dave Houlton48989f32017-05-26 15:01:46 -06002476
Dave Houlton33c2d252017-06-09 17:08:32 -06002477 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2478 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2479 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2480 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2481 "image format %s. %s",
2482 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2483 validation_error_map[VALIDATION_ERROR_09a001e2]);
2484 }
2485
2486 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2487 skip |= log_msg(
2488 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2489 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2490 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2491 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2492 }
2493
Dave Houlton48989f32017-05-26 15:01:46 -06002494 // Validate source image offsets
2495 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002496 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002497 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2498 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2499 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2500 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2501 "of (%1d, %1d). These must be (0, 1). %s",
2502 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2503 }
2504 }
2505
Dave Houlton33c2d252017-06-09 17:08:32 -06002506 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002507 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2508 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2509 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2510 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2511 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2512 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2513 }
2514 }
2515
Dave Houlton33c2d252017-06-09 17:08:32 -06002516 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002517 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2518 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002519 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002520 skip |= log_msg(
2521 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2522 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2523 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2524 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2525 }
2526 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2527 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002528 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002529 skip |= log_msg(
2530 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2531 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2532 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2533 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2534 }
2535 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2536 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002537 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002538 skip |= log_msg(
2539 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2540 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2541 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2542 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2543 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002544 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2545 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2546 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2547 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2548 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2549 } else if (oob) {
2550 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2551 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2552 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2553 validation_error_map[VALIDATION_ERROR_184001ae]);
2554 }
Dave Houlton48989f32017-05-26 15:01:46 -06002555
2556 // Validate dest image offsets
2557 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002558 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002559 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2560 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2561 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2562 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2563 "(%1d, %1d). These must be (0, 1). %s",
2564 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2565 }
2566 }
2567
Dave Houlton33c2d252017-06-09 17:08:32 -06002568 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002569 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2570 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2571 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2572 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2573 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2574 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2575 }
2576 }
2577
Dave Houlton33c2d252017-06-09 17:08:32 -06002578 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002579 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2580 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002581 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002582 skip |= log_msg(
2583 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2584 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2585 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2586 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2587 }
2588 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2589 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002590 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002591 skip |= log_msg(
2592 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2593 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2594 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2595 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2596 }
2597 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2598 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002599 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002600 skip |= log_msg(
2601 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2602 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2603 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2604 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2605 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002606 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002607 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 -06002608 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2609 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2610 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2611 } else if (oob) {
2612 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2613 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2614 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2615 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002616 }
2617
Dave Houlton33c2d252017-06-09 17:08:32 -06002618 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2619 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2620 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2621 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2622 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2623 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2624 "layerCount other than 1. %s",
2625 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002626 }
2627 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002628 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002629 } else {
2630 assert(0);
2631 }
2632 return skip;
2633}
2634
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002635void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002636 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2637 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2638 // Make sure that all image slices are updated to correct layout
2639 for (uint32_t i = 0; i < region_count; ++i) {
2640 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2641 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2642 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002643 // Update bindings between images and cmd buffer
2644 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2645 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2646
2647 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002648 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002649 function = [=]() {
2650 SetImageMemoryValid(device_data, dst_image_state, true);
2651 return false;
2652 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002653 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002654}
2655
Tony Barbourdf013b92017-01-25 12:53:48 -07002656// This validates that the initial layout specified in the command buffer for
2657// the IMAGE is the same
2658// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002659bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002660 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const & globalImageLayoutMap,
2661 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> & overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002662 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002663 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002664 for (auto cb_image_data : pCB->imageLayoutMap) {
2665 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002666
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002667 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
2668 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002669 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2670 // TODO: Set memory invalid which is in mem_tracker currently
2671 } else if (imageLayout != cb_image_data.second.initialLayout) {
2672 if (cb_image_data.first.hasSubresource) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002673 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2674 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2675 "Cannot submit cmd buffer using image (0x%" PRIx64
2676 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
2677 "with layout %s when first use is %s.",
2678 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2679 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2680 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002681 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002682 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2683 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2684 "Cannot submit cmd buffer using image (0x%" PRIx64
2685 ") with layout %s when "
2686 "first use is %s.",
2687 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2688 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002689 }
2690 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002691 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002692 }
2693 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002694 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002695}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002696
Tony Barbourdf013b92017-01-25 12:53:48 -07002697void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2698 for (auto cb_image_data : pCB->imageLayoutMap) {
2699 VkImageLayout imageLayout;
2700 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2701 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2702 }
2703}
2704
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002705// Print readable FlagBits in FlagMask
2706static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2707 std::string result;
2708 std::string separator;
2709
2710 if (accessMask == 0) {
2711 result = "[None]";
2712 } else {
2713 result = "[";
2714 for (auto i = 0; i < 32; i++) {
2715 if (accessMask & (1 << i)) {
2716 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2717 separator = " | ";
2718 }
2719 }
2720 result = result + "]";
2721 }
2722 return result;
2723}
2724
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002725// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2726// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002727// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002728static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2729 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2730 const char *type) {
2731 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2732 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002733
2734 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2735 if (accessMask & ~(required_bit | optional_bits)) {
2736 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002737 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 +02002738 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002739 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2740 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002741 }
2742 } else {
2743 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002744 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 +02002745 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002746 "%s AccessMask %d %s must contain at least one of access bits %d "
2747 "%s when layout is %s, unless the app has previously added a "
2748 "barrier for this transition.",
2749 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2750 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002751 } else {
2752 std::string opt_bits;
2753 if (optional_bits != 0) {
2754 std::stringstream ss;
2755 ss << optional_bits;
2756 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2757 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002758 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 +02002759 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002760 "%s AccessMask %d %s must have required access bit %d %s %s when "
2761 "layout is %s, unless the app has previously added a barrier for "
2762 "this transition.",
2763 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2764 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002765 }
2766 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002767 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002768}
2769
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002770// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002771// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2772// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002773bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002774 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2775 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002776 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2777 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2778 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2779 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002780 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 -06002781 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2782 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002783 }
2784 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002785 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002786}
2787
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002788bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2789 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002790 bool skip = false;
2791
Jason Ekstranda1906302017-12-03 20:16:32 -08002792 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2793 VkFormat format = pCreateInfo->pAttachments[i].format;
2794 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2795 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2796 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2797 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
2798 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2799 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
2800 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
2801 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
2802 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
2803 "image truely is undefined at the start of the render pass.");
2804 }
2805 if (FormatHasStencil(format) &&
2806 pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2807 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
2808 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2809 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
2810 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
2811 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
2812 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
2813 "image truely is undefined at the start of the render pass.");
2814 }
2815 }
2816 }
2817
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002818 // Track when we're observing the first use of an attachment
2819 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2820 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2821 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002822
2823 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2824 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2825 auto attach_index = subpass.pInputAttachments[j].attachment;
2826 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2827
2828 switch (subpass.pInputAttachments[j].layout) {
2829 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2830 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2831 // These are ideal.
2832 break;
2833
2834 case VK_IMAGE_LAYOUT_GENERAL:
2835 // May not be optimal. TODO: reconsider this warning based on other constraints.
2836 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2837 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2838 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2839 break;
2840
2841 default:
2842 // No other layouts are acceptable
2843 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2844 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2845 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2846 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2847 }
2848
2849 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2850 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2851 subpass.pDepthStencilAttachment->attachment == attach_index &&
2852 subpass.pDepthStencilAttachment->layout != layout;
2853 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2854 found_layout_mismatch =
2855 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2856 }
2857 if (found_layout_mismatch) {
2858 skip |= log_msg(
2859 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002860 VALIDATION_ERROR_140006ae, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002861 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a depth/color "
2862 "attachment with a different layout. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002863 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002864 }
2865
2866 if (attach_first_use[attach_index]) {
2867 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2868 pCreateInfo->pAttachments[attach_index]);
2869
2870 bool used_as_depth =
2871 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2872 bool used_as_color = false;
2873 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2874 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2875 }
2876 if (!used_as_depth && !used_as_color &&
2877 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2878 skip |= log_msg(
2879 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002880 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002881 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002882 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002883 }
2884 }
2885 attach_first_use[attach_index] = false;
2886 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002887 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2888 auto attach_index = subpass.pColorAttachments[j].attachment;
2889 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2890
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002891 // TODO: Need a way to validate shared presentable images here, currently just allowing
2892 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2893 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002894 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002895 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002896 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002897 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2898 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002899 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002900
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002901 case VK_IMAGE_LAYOUT_GENERAL:
2902 // May not be optimal; TODO: reconsider this warning based on other constraints?
2903 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2904 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2905 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2906 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002907
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002908 default:
2909 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2910 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2911 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2912 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002913 }
2914
2915 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002916 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2917 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002918 }
2919 attach_first_use[attach_index] = false;
2920 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002921
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002922 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2923 switch (subpass.pDepthStencilAttachment->layout) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06002924 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2925 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2926 // These are ideal.
2927 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002928
Lenny Komowb79f04a2017-09-18 17:07:00 -06002929 case VK_IMAGE_LAYOUT_GENERAL:
2930 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2931 // doing a bunch of transitions.
2932 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2933 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2934 "GENERAL layout for depth attachment may not give optimal performance.");
2935 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002936
Lenny Komowb79f04a2017-09-18 17:07:00 -06002937 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2938 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2939 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2940 break;
2941 } else {
2942 // Intentionally fall through to generic error message
2943 }
2944
2945 default:
2946 // No other layouts are acceptable
2947 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2948 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2949 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2950 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2951 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002952 }
2953
2954 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2955 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002956 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2957 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002958 }
2959 attach_first_use[attach_index] = false;
2960 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002961 }
2962 return skip;
2963}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002964
2965// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002966bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2967 VkDeviceSize offset, VkDeviceSize end_offset) {
2968 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2969 bool skip = false;
2970 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2971 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002972 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2973 for (auto image_handle : mem_info->bound_images) {
2974 auto img_it = mem_info->bound_ranges.find(image_handle);
2975 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002976 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002977 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002978 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002979 for (auto layout : layouts) {
2980 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002981 skip |=
2982 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
2983 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2984 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2985 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
2986 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002987 }
2988 }
2989 }
2990 }
2991 }
2992 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002993 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002994}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002995
2996// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2997// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002998static 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 -06002999 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003000 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003001
3002 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003003 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003004 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003005 if (strict) {
3006 correct_usage = ((actual & desired) == desired);
3007 } else {
3008 correct_usage = ((actual & desired) != 0);
3009 }
3010 if (!correct_usage) {
3011 if (msgCode == -1) {
3012 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06003013 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 +01003014 MEMTRACK_INVALID_USAGE_FLAG, "MEM", "Invalid usage flag for %s 0x%" PRIx64
3015 " used by %s. In this case, %s should have %s set during creation.",
Mark Lobodzinski33826372017-04-13 11:10:11 -06003016 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003017 } else {
3018 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Petr Kraus13c98a62017-12-09 00:22:39 +01003019 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
3020 msgCode, "MEM", "Invalid usage flag for %s 0x%" PRIx64
3021 " used by %s. In this case, %s should have %s set during creation. %s",
3022 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003023 }
3024 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003025 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003026}
3027
3028// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3029// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003030bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003031 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003032 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3033 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003034}
3035
3036// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3037// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003038bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003039 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003040 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3041 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003042}
3043
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003044bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003045 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003046 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3047
Chris Forbese0f511c2017-06-14 12:38:01 -07003048 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003049
3050 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3051 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 -06003052 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003053 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3054 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003055 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003056 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003057
3058 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
3059 skip |=
3060 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 -07003061 VALIDATION_ERROR_01400728, "DS",
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003062 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003063 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3064 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003065 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003066
3067 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
3068 skip |=
3069 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 -07003070 VALIDATION_ERROR_0140072a, "DS",
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003071 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003072 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3073 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003074 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003075 return skip;
3076}
3077
3078void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3079 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3080 GetBufferMap(device_data)
3081 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3082}
3083
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003084bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3085 bool skip = false;
3086 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003087 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3088 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003089 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003090 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3091 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003092 skip |= ValidateBufferUsageFlags(
3093 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 -06003094 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003095 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003096 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003097}
3098
3099void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3100 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3101}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003102
3103// For the given format verify that the aspect masks make sense
3104bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3105 const char *func_name) {
3106 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3107 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003108 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003109 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003110 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 -06003111 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003112 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003113 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003114 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003115 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 -06003116 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003117 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003118 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003119 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003120 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003121 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003122 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003123 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003124 "%s: Depth/stencil image formats must have "
3125 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
3126 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003127 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003128 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003129 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 -06003130 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003131 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3132 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003133 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003134 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003135 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003136 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003137 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 -06003138 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003139 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003140 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003141 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003142 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003143 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003144 "%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 -06003145 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003146 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003147 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003148 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003149 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 -06003150 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003151 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003152 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003153 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003154 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 -06003155 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003156 "%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 -06003157 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003158 }
3159 }
3160 return skip;
3161}
3162
Petr Krausffa94af2017-08-08 21:46:02 +02003163struct SubresourceRangeErrorCodes {
3164 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3165};
3166
3167bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3168 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3169 const char *image_layer_count_var_name, const uint64_t image_handle,
3170 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003171 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3172 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003173
3174 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003175 if (subresourceRange.baseMipLevel >= image_mip_count) {
3176 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3177 errorCodes.base_mip_err, "IMAGE",
3178 "%s: %s.baseMipLevel (= %" PRIu32
3179 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 "). %s",
3180 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count,
3181 validation_error_map[errorCodes.base_mip_err]);
3182 }
Petr Kraus4d718682017-05-18 03:38:41 +02003183
Petr Krausffa94af2017-08-08 21:46:02 +02003184 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3185 if (subresourceRange.levelCount == 0) {
3186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3187 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0. %s", cmd_name, param_name,
3188 validation_error_map[errorCodes.mip_count_err]);
3189 } else {
3190 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003191
Petr Krausffa94af2017-08-08 21:46:02 +02003192 if (necessary_mip_count > image_mip_count) {
3193 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3194 __LINE__, errorCodes.mip_count_err, "IMAGE",
3195 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3196 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3197 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
3198 necessary_mip_count, image_mip_count, validation_error_map[errorCodes.mip_count_err]);
3199 }
Petr Kraus4d718682017-05-18 03:38:41 +02003200 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003201 }
Petr Kraus4d718682017-05-18 03:38:41 +02003202
3203 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003204 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3205 skip |=
3206 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3207 errorCodes.base_layer_err, "IMAGE",
3208 "%s: %s.baseArrayLayer (= %" PRIu32
3209 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 "). %s",
3210 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count,
3211 validation_error_map[errorCodes.base_layer_err]);
3212 }
Petr Kraus4d718682017-05-18 03:38:41 +02003213
Petr Krausffa94af2017-08-08 21:46:02 +02003214 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3215 if (subresourceRange.layerCount == 0) {
3216 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3217 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0. %s", cmd_name, param_name,
3218 validation_error_map[errorCodes.layer_count_err]);
3219 } else {
3220 const uint64_t necessary_layer_count =
3221 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003222
Petr Krausffa94af2017-08-08 21:46:02 +02003223 if (necessary_layer_count > image_layer_count) {
3224 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3225 __LINE__, errorCodes.layer_count_err, "IMAGE",
3226 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3227 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3228 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
3229 necessary_layer_count, image_layer_count_var_name, image_layer_count,
3230 validation_error_map[errorCodes.layer_count_err]);
3231 }
Petr Kraus4d718682017-05-18 03:38:41 +02003232 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003233 }
Petr Kraus4d718682017-05-18 03:38:41 +02003234
Mark Lobodzinski602de982017-02-09 11:01:33 -07003235 return skip;
3236}
3237
Petr Krausffa94af2017-08-08 21:46:02 +02003238bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3239 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3240 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3241 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3242 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3243 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3244
3245 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3246 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3247
3248 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3249 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
3250 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00b8e;
3251 subresourceRangeErrorCodes.base_layer_err =
3252 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3253 subresourceRangeErrorCodes.layer_count_err =
3254 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00b92;
3255
3256 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3257 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3258 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3259}
3260
3261bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3262 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3263 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3264 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
3265 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800b7e;
3266 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
3267 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800b82;
3268
3269 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3270 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3271 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3272}
3273
3274bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3275 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3276 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3277 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
3278 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00b86;
3279 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
3280 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00b8a;
3281
3282 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3283 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3284 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3285}
3286
3287bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3288 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3289 const char *param_name) {
3290 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3291 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
3292 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000b9e;
3293 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
3294 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000ba2;
3295
3296 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3297 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3298 subresourceRangeErrorCodes);
3299}
3300
Mark Lobodzinski602de982017-02-09 11:01:33 -07003301bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3302 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3303 bool skip = false;
3304 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3305 if (image_state) {
3306 skip |= ValidateImageUsageFlags(
3307 device_data, image_state,
3308 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06003309 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003310 false, -1, "vkCreateImageView()",
3311 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3312 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003313 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003314 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003315 skip |= ValidateCreateImageViewSubresourceRange(
3316 device_data, image_state,
3317 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3318 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003319
3320 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3321 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003322 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3323 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003324 VkFormat view_format = create_info->format;
3325 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003326 VkImageType image_type = image_state->createInfo.imageType;
3327 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003328
3329 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3330 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003331 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3332 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3333 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3334 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3335 std::stringstream ss;
3336 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3337 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3338 << ") format " << string_VkFormat(image_format)
3339 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3340 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3341 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3342 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3343 validation_error_map[VALIDATION_ERROR_0ac007f4]);
3344 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003345 }
3346 } else {
3347 // Format MUST be IDENTICAL to the format the image was created with
3348 if (image_format != view_format) {
3349 std::stringstream ss;
3350 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003351 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003352 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003353 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 -06003354 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3355 validation_error_map[VALIDATION_ERROR_0ac007f6]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003356 }
3357 }
3358
3359 // Validate correct image aspect bits for desired formats and format consistency
3360 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003361
3362 switch (image_type) {
3363 case VK_IMAGE_TYPE_1D:
3364 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3366 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3367 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3368 string_VkImageViewType(view_type), string_VkImageType(image_type),
3369 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3370 }
3371 break;
3372 case VK_IMAGE_TYPE_2D:
3373 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3374 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3375 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3377 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
3378 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3379 string_VkImageViewType(view_type), string_VkImageType(image_type),
3380 validation_error_map[VALIDATION_ERROR_0ac007d6]);
3381 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3383 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3384 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3385 string_VkImageViewType(view_type), string_VkImageType(image_type),
3386 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3387 }
3388 }
3389 break;
3390 case VK_IMAGE_TYPE_3D:
3391 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3392 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3393 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3394 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
3395 skip |= log_msg(
3396 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3397 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3398 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3399 string_VkImageViewType(view_type), string_VkImageType(image_type),
3400 validation_error_map[VALIDATION_ERROR_0ac007da]);
3401 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3402 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
3403 skip |= log_msg(
3404 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3405 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3406 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s when the "
3407 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
3408 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled. %s",
3409 string_VkImageViewType(view_type), string_VkImageType(image_type),
3410 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3411 }
3412 } else {
3413 skip |=
3414 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3415 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3416 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3417 string_VkImageViewType(view_type), string_VkImageType(image_type),
3418 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3419 }
3420 }
3421 } else {
3422 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3423 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3424 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3425 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3426 string_VkImageViewType(view_type), string_VkImageType(image_type),
3427 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3428 }
3429 }
3430 break;
3431 default:
3432 break;
3433 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003434
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003435 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003436 bool check_tiling_features = false;
3437 VkFormatFeatureFlags tiling_features = 0;
3438 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3439 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3440 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3441 };
3442 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3443 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3444 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3445 };
3446 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3447 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003448 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003449 error_codes = linear_error_codes;
3450 check_tiling_features = true;
3451 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003452 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003453 error_codes = optimal_error_codes;
3454 check_tiling_features = true;
3455 }
3456
3457 if (check_tiling_features) {
3458 if (tiling_features == 0) {
3459 skip |=
3460 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3461 error_codes[0], "IMAGE",
3462 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3463 "%s flag set. %s",
3464 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[0]]);
3465 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
3466 skip |=
3467 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3468 error_codes[1], "IMAGE",
3469 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3470 "%s and VK_IMAGE_USAGE_SAMPLED_BIT flags set. %s",
3471 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[1]]);
3472 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
3473 skip |=
3474 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3475 error_codes[2], "IMAGE",
3476 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3477 "%s and VK_IMAGE_USAGE_STORAGE_BIT flags set. %s",
3478 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[2]]);
3479 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3480 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
3481 skip |=
3482 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3483 error_codes[3], "IMAGE",
3484 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3485 "%s and VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set. %s",
3486 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[3]]);
3487 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3488 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
3489 skip |=
3490 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3491 error_codes[4], "IMAGE",
3492 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3493 "%s and VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set. %s",
3494 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[4]]);
3495 }
3496 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003497 }
3498 return skip;
3499}
3500
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003501void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3502 auto image_view_map = GetImageViewMap(device_data);
3503 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3504
3505 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003506 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003507 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3508 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003509}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003510
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003511bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3512 BUFFER_STATE *dst_buffer_state) {
3513 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003514 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3515 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003516 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003517 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3518 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3519 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3520 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003521 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003522 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003523 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003524 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003525 return skip;
3526}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003527
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003528void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3529 BUFFER_STATE *dst_buffer_state) {
3530 // Update bindings between buffers and cmd buffer
3531 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3532 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3533
3534 std::function<bool()> function = [=]() {
3535 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3536 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003537 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003538 function = [=]() {
3539 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3540 return false;
3541 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003542 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003543}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003544
3545static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3546 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3547 bool skip = false;
3548 auto buffer_state = GetBufferState(device_data, buffer);
3549 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003550 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 +01003551 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS", "Cannot free buffer 0x%" PRIx64 " that has not been allocated.",
3552 HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003553 } else {
3554 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003555 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 -06003556 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Kraus13c98a62017-12-09 00:22:39 +01003557 "Cannot free buffer 0x%" PRIx64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003558 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003559 }
3560 }
3561 return skip;
3562}
3563
3564bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3565 VK_OBJECT *obj_struct) {
3566 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003567 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003568 if (GetDisables(device_data)->destroy_image_view) return false;
3569 bool skip = false;
3570 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003571 skip |=
3572 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003573 }
3574 return skip;
3575}
3576
3577void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3578 VK_OBJECT obj_struct) {
3579 // Any bound cmd buffers are now invalid
3580 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3581 (*GetImageViewMap(device_data)).erase(image_view);
3582}
3583
3584bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3585 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003586 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003587 if (GetDisables(device_data)->destroy_buffer) return false;
3588 bool skip = false;
3589 if (*buffer_state) {
3590 skip |= validateIdleBuffer(device_data, buffer);
3591 }
3592 return skip;
3593}
3594
3595void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3596 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3597 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3598 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3599 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003600 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003601 }
3602 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003603 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003604 GetBufferMap(device_data)->erase(buffer_state->buffer);
3605}
3606
3607bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3608 VK_OBJECT *obj_struct) {
3609 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003610 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003611 if (GetDisables(device_data)->destroy_buffer_view) return false;
3612 bool skip = false;
3613 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003614 skip |=
3615 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003616 }
3617 return skip;
3618}
3619
3620void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3621 VK_OBJECT obj_struct) {
3622 // Any bound cmd buffers are now invalid
3623 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3624 GetBufferViewMap(device_data)->erase(buffer_view);
3625}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003626
3627bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3628 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003629 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003630 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003631 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003632 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3633 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003634 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003635 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003636 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003637 return skip;
3638}
3639
3640void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3641 std::function<bool()> function = [=]() {
3642 SetBufferMemoryValid(device_data, buffer_state, true);
3643 return false;
3644 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003645 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003646 // Update bindings between buffer and cmd buffer
3647 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003648}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003649
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003650bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3651 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003652 bool skip = false;
3653
3654 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003655 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3656 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003657 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 -06003658 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003659 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
3660 "must be 0 and 1, respectively. %s",
3661 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003662 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003663 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003664 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003665
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003666 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3667 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003668 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 -06003669 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003670 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3671 "must be 0 and 1, respectively. %s",
3672 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003673 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003674 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003675 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003676
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003677 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3678 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3679 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 -06003680 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003681 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
3682 "%d. For 3D images these must be 0 and 1, respectively. %s",
3683 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003684 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003685 }
3686 }
3687
3688 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3689 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003690 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003691 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003692 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 -06003693 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003694 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3695 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003696 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003697 }
3698
3699 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003700 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003701 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 -06003702 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003703 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003704 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003705 }
3706
3707 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3708 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3709 skip |= log_msg(
3710 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003711 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003712 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3713 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003714 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003715 }
3716
3717 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3718 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3719 skip |= log_msg(
3720 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003721 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003722 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3723 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003724 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003725 }
3726
3727 // subresource aspectMask must have exactly 1 bit set
3728 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3729 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3730 if (aspect_mask_bits.count() != 1) {
3731 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 -06003732 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003733 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003734 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003735 }
3736
3737 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003738 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003739 skip |= log_msg(
3740 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003741 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003742 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3743 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003744 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003745 }
3746
3747 // Checks that apply only to compressed images
3748 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3749 // reserves a place for these compressed image checks. This block of code could move there once the image
3750 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003751 if (FormatIsCompressed(image_state->createInfo.format)) {
3752 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003753
3754 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003755 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003756 skip |= log_msg(
3757 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003758 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003759 "%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 -06003760 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003761 }
3762
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003763 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003764 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003765 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 -06003766 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003767 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
3768 "height (%d). %s.",
3769 function, i, pRegions[i].bufferImageHeight, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003770 validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003771 }
3772
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003773 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003774 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3775 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3776 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003777 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 -06003778 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003779 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3780 "width & height (%d, %d). %s.",
3781 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003782 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003783 }
3784
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003785 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003786 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3787 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003788 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 -06003789 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003790 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3791 ") must be a multiple of the compressed image's texel block "
3792 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3793 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003794 validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003795 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003796
3797 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003798 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003799 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003800 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3801 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 -06003802 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003803 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3804 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3805 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003806 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003807 }
3808
3809 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003810 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003811 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3812 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 -06003813 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003814 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3815 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3816 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003817 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003818 }
3819
3820 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003821 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003822 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3823 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 -06003824 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003825 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3826 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3827 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003828 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003829 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003830 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003831 }
3832
3833 return skip;
3834}
3835
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003836static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3837 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003838 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003839 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003840
3841 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003842 VkExtent3D extent = pRegions[i].imageExtent;
3843 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003844
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003845 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3846 {
3847 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3848 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3849 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3850 extent.height, extent.depth);
3851 }
3852
3853 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3854
3855 // 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 -06003856 if (FormatIsCompressed(image_info->format)) {
3857 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003858 if (image_extent.width % block_extent.width) {
3859 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3860 }
3861 if (image_extent.height % block_extent.height) {
3862 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3863 }
3864 if (image_extent.depth % block_extent.depth) {
3865 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3866 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003867 }
3868
Dave Houltonfc1a4052017-04-27 14:32:45 -06003869 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003870 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 -07003871 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003872 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003873 }
3874 }
3875
3876 return skip;
3877}
3878
Chris Forbese8ba09a2017-06-01 17:39:02 -07003879static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003880 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3881 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003882 bool skip = false;
3883
3884 VkDeviceSize buffer_size = buff_state->createInfo.size;
3885
3886 for (uint32_t i = 0; i < regionCount; i++) {
3887 VkExtent3D copy_extent = pRegions[i].imageExtent;
3888
3889 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3890 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003891 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003892
Dave Houltonf3229d52017-02-21 15:59:08 -07003893 // Handle special buffer packing rules for specific depth/stencil formats
3894 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003895 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003896 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3897 switch (image_state->createInfo.format) {
3898 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003899 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003900 break;
3901 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003902 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003903 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003904 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003905 case VK_FORMAT_D24_UNORM_S8_UINT:
3906 unit_size = 4;
3907 break;
3908 default:
3909 break;
3910 }
3911 }
3912
Dave Houlton1d2022c2017-03-29 11:43:58 -06003913 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003914 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003915 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003916 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3917 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3918
3919 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3920 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3921 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003922 }
3923
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003924 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3925 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3926 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003927 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003928 } else {
3929 // Calculate buffer offset of final copied byte, + 1.
3930 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3931 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3932 max_buffer_offset *= unit_size; // convert to bytes
3933 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003934
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003935 if (buffer_size < max_buffer_offset) {
3936 skip |=
3937 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3938 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
3939 i, buffer_size, validation_error_map[msg_code]);
3940 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003941 }
3942 }
3943
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003944 return skip;
3945}
3946
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003947bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003948 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003949 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003950 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3951 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3952
3953 // Validate command buffer state
3954 if (CB_RECORDING != cb_node->state) {
3955 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 -06003956 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_19202413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003957 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003958 validation_error_map[VALIDATION_ERROR_19202413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003959 } else {
3960 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
3961 }
3962
3963 // Command pool must support graphics, compute, or transfer operations
3964 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3965
3966 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3967 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3968 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 -06003969 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003970 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
3971 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003972 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003973 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003974 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003975 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07003976 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06003977 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003978
3979 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003980 VALIDATION_ERROR_19200178);
3981 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
3982 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003983
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003984 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003985 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003986 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003987 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3988 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
3989 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003990 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003991 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003992 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
3993 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
3994 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003995 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003996 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003997 }
3998 return skip;
3999}
4000
4001void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004002 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4003 VkImageLayout src_image_layout) {
4004 // Make sure that all image slices are updated to correct layout
4005 for (uint32_t i = 0; i < region_count; ++i) {
4006 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4007 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004008 // Update bindings between buffer/image and cmd buffer
4009 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004010 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004011
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004012 std::function<bool()> function = [=]() {
4013 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4014 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004015 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004016 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004017 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004018 return false;
4019 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004020 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004021}
4022
4023bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004024 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004025 const VkBufferImageCopy *pRegions, const char *func_name) {
4026 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4027 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4028
4029 // Validate command buffer state
4030 if (CB_RECORDING != cb_node->state) {
4031 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 -06004032 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_18e02413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004033 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004034 validation_error_map[VALIDATION_ERROR_18e02413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004035 } else {
4036 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
4037 }
4038
4039 // Command pool must support graphics, compute, or transfer operations
4040 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4041 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4042 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4043 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 -06004044 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004045 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
4046 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004047 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004048 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004049 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004050 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004051 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004052 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004053 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004054 VALIDATION_ERROR_18e00166);
4055 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4056 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4057 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4058 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4059 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004060 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004061 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004062 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004063 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004064 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4065 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4066 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004067 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4068 "vkCmdCopyBufferToImage()");
4069 }
4070 return skip;
4071}
4072
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004073void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004074 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4075 VkImageLayout dst_image_layout) {
4076 // Make sure that all image slices are updated to correct layout
4077 for (uint32_t i = 0; i < region_count; ++i) {
4078 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4079 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004080 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004081 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004082 std::function<bool()> function = [=]() {
4083 SetImageMemoryValid(device_data, dst_image_state, true);
4084 return false;
4085 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004086 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004087 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004088 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004089}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004090
4091bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4092 const auto report_data = core_validation::GetReportData(device_data);
4093 bool skip = false;
4094 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4095
Dave Houlton1d960ff2018-01-19 12:17:05 -07004096 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004097 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4098 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4099 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004100 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 -06004101 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004102 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004103 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004104 }
4105
4106 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4107 if (!image_entry) {
4108 return skip;
4109 }
4110
Dave Houlton1d960ff2018-01-19 12:17:05 -07004111 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004112 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004113 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 -06004114 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004115 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004116 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004117 }
4118
Dave Houlton1d960ff2018-01-19 12:17:05 -07004119 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004120 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004121 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 -06004122 __LINE__, VALIDATION_ERROR_0a4007cc, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004123 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004124 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_0a4007cc]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004125 }
4126
Dave Houlton1d960ff2018-01-19 12:17:05 -07004127 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004128 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004129 skip |=
4130 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4131 __LINE__, VALIDATION_ERROR_0a4007ce, "IMAGE",
4132 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
4133 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_0a4007ce]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004134 }
4135
Dave Houlton1d960ff2018-01-19 12:17:05 -07004136 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004137 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004138 if (FormatIsMultiplane(img_format)) {
4139 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
4140 UNIQUE_VALIDATION_ERROR_CODE vuid = VALIDATION_ERROR_2a600c5a; // 2-plane version
4141 if (FormatPlaneCount(img_format) > 2u) {
4142 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
4143 vuid = VALIDATION_ERROR_2a600c5c; // 3-plane version
4144 }
4145 if (sub_aspect != (sub_aspect & allowed_flags)) {
4146 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4147 HandleToUint64(image), __LINE__, vuid, "IMAGE",
4148 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
4149 ") must be a single-plane specifier flag. %s",
4150 sub_aspect, validation_error_map[vuid]);
4151 }
4152 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004153 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004154 skip |= log_msg(
4155 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), __LINE__,
4156 VALIDATION_ERROR_0a400c01, "IMAGE",
4157 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
4158 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004159 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004160 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004161 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004162 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 -06004163 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004164 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
4165 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004166 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004167 }
4168 }
4169 return skip;
4170}