blob: cafa37e533cd0c2bededd866a80111bbcc18e27e [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
Petr Kraus4d718682017-05-18 03:38:41 +020036// TODO: remove on NDK update (r15 will probably have proper STL impl)
37#ifdef __ANDROID__
38namespace std {
39
40template <typename T>
41std::string to_string(T var) {
42 std::ostringstream ss;
43 ss << var;
44 return ss.str();
45}
Dave Houlton33c2d252017-06-09 17:08:32 -060046} // namespace std
Petr Kraus4d718682017-05-18 03:38:41 +020047#endif
48
Tobin Ehlis58c884f2017-02-08 12:15:27 -070049void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Chris Forbes4eab4b02017-04-26 10:21:20 -070050 if (pCB->imageLayoutMap.find(imgpair) != pCB->imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070051 pCB->imageLayoutMap[imgpair].layout = layout;
52 } else {
53 assert(imgpair.hasSubresource);
54 IMAGE_CMD_BUF_LAYOUT_NODE node;
55 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
56 node.initialLayout = layout;
57 }
58 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
59 }
60}
61template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070062void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070063 ImageSubresourcePair imgpair = {image, true, range};
64 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
65 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
66 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
67 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
68}
69
70template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070071void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070072 VkImageAspectFlags aspectMask) {
73 if (imgpair.subresource.aspectMask & aspectMask) {
74 imgpair.subresource.aspectMask = aspectMask;
75 SetLayout(device_data, pObject, imgpair, layout);
76 }
77}
78
Tony Barbourdf013b92017-01-25 12:53:48 -070079// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070080void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
81 VkImageLayout layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -070082 imageLayoutMap[imgpair].layout = layout;
83}
84
Tobin Ehlisc8266452017-04-07 12:20:30 -060085bool FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070086 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
87 const debug_report_data *report_data = core_validation::GetReportData(device_data);
88
89 if (!(imgpair.subresource.aspectMask & aspectMask)) {
90 return false;
91 }
92 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
93 imgpair.subresource.aspectMask = aspectMask;
94 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
95 if (imgsubIt == pCB->imageLayoutMap.end()) {
96 return false;
97 }
98 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +020099 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
100 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700101 "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 +0200102 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700103 string_VkImageLayout(imgsubIt->second.layout));
104 }
105 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200106 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
107 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700108 "Cannot query for VkImage 0x%" PRIx64
109 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200110 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700111 string_VkImageLayout(imgsubIt->second.initialLayout));
112 }
113 node = imgsubIt->second;
114 return true;
115}
116
Tobin Ehlisc8266452017-04-07 12:20:30 -0600117bool FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700118 const VkImageAspectFlags aspectMask) {
119 if (!(imgpair.subresource.aspectMask & aspectMask)) {
120 return false;
121 }
122 const debug_report_data *report_data = core_validation::GetReportData(device_data);
123 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
124 imgpair.subresource.aspectMask = aspectMask;
125 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
126 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
127 return false;
128 }
129 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200130 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
131 __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700132 "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 +0200133 HandleToUint64(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700134 string_VkImageLayout(imgsubIt->second.layout));
135 }
136 layout = imgsubIt->second.layout;
137 return true;
138}
139
140// Find layout(s) on the command buffer level
Tobin Ehlisc8266452017-04-07 12:20:30 -0600141bool FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700142 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
143 ImageSubresourcePair imgpair = {image, true, range};
144 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
145 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
146 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
147 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
148 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
149 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
150 imgpair = {image, false, VkImageSubresource()};
151 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
152 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
153 // TODO: This is ostensibly a find function but it changes state here
154 node = imgsubIt->second;
155 }
156 return true;
157}
158
159// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700160bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700161 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
162 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
163 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
164 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
165 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
166 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
167 imgpair = {imgpair.image, false, VkImageSubresource()};
168 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
169 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
170 layout = imgsubIt->second.layout;
171 }
172 return true;
173}
174
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700175bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700176 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
177 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700178 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700179 if (!image_state) return false;
180 bool ignoreGlobal = false;
181 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
182 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
183 ignoreGlobal = true;
184 }
185 for (auto imgsubpair : sub_data->second) {
186 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
187 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
188 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
189 layouts.push_back(img_data->second.layout);
190 }
191 }
192 return true;
193}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700194bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
195 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700196 if (!(imgpair.subresource.aspectMask & aspectMask)) {
197 return false;
198 }
199 imgpair.subresource.aspectMask = aspectMask;
200 auto imgsubIt = imageLayoutMap.find(imgpair);
201 if (imgsubIt == imageLayoutMap.end()) {
202 return false;
203 }
204 layout = imgsubIt->second.layout;
205 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700206}
Tony Barbourdf013b92017-01-25 12:53:48 -0700207
208// find layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -0700209bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
210 VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700211 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
212 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
213 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
214 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
215 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
216 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
217 imgpair = {imgpair.image, false, VkImageSubresource()};
218 auto imgsubIt = imageLayoutMap.find(imgpair);
219 if (imgsubIt == imageLayoutMap.end()) return false;
220 layout = imgsubIt->second.layout;
221 }
222 return true;
223}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700224
225// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700226void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700227 VkImage &image = imgpair.image;
228 (*core_validation::GetImageLayoutMap(device_data))[imgpair].layout = layout;
229 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
230 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
231 if (subresource == image_subresources.end()) {
232 image_subresources.push_back(imgpair);
233 }
234}
235
236// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700237void 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 -0700238 pCB->imageLayoutMap[imgpair] = node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700239}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600240// Set image layout for given VkImageSubresourceRange struct
241void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
242 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
243 assert(image_state);
244 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
245 uint32_t level = image_subresource_range.baseMipLevel + level_index;
246 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
247 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
248 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700249 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
250 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600251 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600252 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700253 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
254 }
255 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600256 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700257 }
258 }
259}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600260// Set image layout for given VkImageSubresourceLayers struct
261void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
262 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
263 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
264 VkImageSubresourceRange image_subresource_range;
265 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
266 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
267 image_subresource_range.layerCount = image_subresource_layers.layerCount;
268 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
269 image_subresource_range.levelCount = 1;
270 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
271}
272// Set image layout for all slices of an image view
273void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
274 auto view_state = GetImageViewState(device_data, imageView);
275 assert(view_state);
276
277 SetImageLayout(device_data, cb_node, GetImageState(device_data, view_state->create_info.image),
278 view_state->create_info.subresourceRange, layout);
279}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700280
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700281bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700282 const VkRenderPassBeginInfo *pRenderPassBegin,
283 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600284 bool skip = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700285 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700286 auto const &framebufferInfo = framebuffer_state->createInfo;
287 const auto report_data = core_validation::GetReportData(device_data);
288 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600289 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 +0200290 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600291 "You cannot start a render pass using a framebuffer "
292 "with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700293 }
294 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
295 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700296 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700297 assert(view_state);
298 const VkImage &image = view_state->create_info.image;
299 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700300 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700301 // TODO: Do not iterate over every possibility - consolidate where possible
302 for (uint32_t j = 0; j < subRange.levelCount; j++) {
303 uint32_t level = subRange.baseMipLevel + j;
304 for (uint32_t k = 0; k < subRange.layerCount; k++) {
305 uint32_t layer = subRange.baseArrayLayer + k;
306 VkImageSubresource sub = {subRange.aspectMask, level, layer};
307 IMAGE_CMD_BUF_LAYOUT_NODE node;
308 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700309 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700310 continue;
311 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700312 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600313 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
314 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
315 "You cannot start a render pass using attachment %u "
316 "where the render pass initial layout is %s and the previous "
317 "known layout of the attachment is %s. The layouts must match, or "
318 "the render pass initial layout for the attachment must be "
319 "VK_IMAGE_LAYOUT_UNDEFINED",
320 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700321 }
322 }
323 }
324 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600325 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700326}
327
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700328void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700329 VkAttachmentReference ref) {
330 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
331 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
332 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
333 }
334}
335
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700336void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700337 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700338 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700339
340 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700341 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700342 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
343 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
344 }
345 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
346 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
347 }
348 if (subpass.pDepthStencilAttachment) {
349 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
350 }
351 }
352}
353
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700354bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
355 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700356 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
357 return false;
358 }
359 VkImageSubresource sub = {aspect, level, layer};
360 IMAGE_CMD_BUF_LAYOUT_NODE node;
361 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700362 return false;
363 }
364 bool skip = false;
365 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
366 // TODO: Set memory invalid which is in mem_tracker currently
367 } else if (node.layout != mem_barrier->oldLayout) {
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600368 skip |=
369 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200370 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(pCB->commandBuffer), __LINE__,
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600371 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
372 "For image 0x%" PRIxLEAST64 " you cannot transition the layout of aspect %d from %s when current layout is %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +0200373 HandleToUint64(mem_barrier->image), aspect, string_VkImageLayout(mem_barrier->oldLayout),
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600374 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700375 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700376 return skip;
377}
378
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700379// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
380// 1. Transition into initialLayout state
381// 2. Transition from initialLayout to layout used in subpass 0
382void TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
383 FRAMEBUFFER_STATE *framebuffer_state) {
384 // First transition into initialLayout
385 auto const rpci = render_pass_state->createInfo.ptr();
386 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
387 VkImageView image_view = framebuffer_state->createInfo.pAttachments[i];
388 SetImageViewLayout(device_data, cb_state, image_view, rpci->pAttachments[i].initialLayout);
389 }
390 // Now transition for first subpass (index 0)
391 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
392}
393
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700394void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
395 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
396 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
397 return;
398 }
399 VkImageSubresource sub = {aspect, level, layer};
400 IMAGE_CMD_BUF_LAYOUT_NODE node;
401 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
402 SetLayout(device_data, pCB, mem_barrier->image, sub,
403 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
404 return;
405 }
406 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
407 // TODO: Set memory invalid
408 }
409 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
410}
411
Dave Houlton10b39482017-03-16 13:18:15 -0600412bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600413 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600414 if (!FormatIsColor(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600415 }
416 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600417 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600418 }
419 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600420 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600421 }
422 return true;
423}
424
Mike Weiblen62d08a32017-03-07 22:18:27 -0700425// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
426bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
427 VkImageUsageFlags usage_flags, const char *func_name) {
428 const auto report_data = core_validation::GetReportData(device_data);
429 bool skip = false;
430 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
431 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
432
433 switch (layout) {
434 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
435 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600436 msg_code = VALIDATION_ERROR_0a000970;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700437 }
438 break;
439 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
440 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600441 msg_code = VALIDATION_ERROR_0a000972;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700442 }
443 break;
444 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
445 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600446 msg_code = VALIDATION_ERROR_0a000974;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700447 }
448 break;
449 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
450 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600451 msg_code = VALIDATION_ERROR_0a000976;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700452 }
453 break;
454 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
455 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600456 msg_code = VALIDATION_ERROR_0a000978;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700457 }
458 break;
459 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
460 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600461 msg_code = VALIDATION_ERROR_0a00097a;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700462 }
463 break;
464 default:
465 // Other VkImageLayout values do not have VUs defined in this context.
466 break;
467 }
468
469 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600470 skip |=
471 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200472 HandleToUint64(img_barrier->image), __LINE__, msg_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600473 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ". %s",
474 func_name, img_barrier, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
Petr Krausbc7f5442017-05-14 23:43:38 +0200475 HandleToUint64(img_barrier->image), usage_flags, validation_error_map[msg_code]);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700476 }
477 return skip;
478}
479
480// Verify image barriers are compatible with the images they reference.
481bool ValidateBarriersToImages(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t imageMemoryBarrierCount,
482 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700483 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700484 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700485
Mike Weiblen62d08a32017-03-07 22:18:27 -0700486 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
487 auto img_barrier = &pImageMemoryBarriers[i];
488 if (!img_barrier) continue;
489
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600490 auto image_state = GetImageState(device_data, img_barrier->image);
491 if (image_state) {
492 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
493 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
494 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
495
496 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
497 if (image_state->layout_locked) {
498 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600499 skip |= log_msg(
500 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600501 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, 0, "DS",
502 "Attempting to transition shared presentable image 0x%" PRIxLEAST64
503 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
504 reinterpret_cast<const uint64_t &>(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
505 string_VkImageLayout(img_barrier->newLayout));
506 }
507 }
508
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600509 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600510 // For a Depth/Stencil image both aspects MUST be set
511 if (FormatIsDepthAndStencil(image_create_info->format)) {
512 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
513 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
514 if ((aspect_mask & ds_mask) != (ds_mask)) {
515 skip |=
516 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200517 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600518 VALIDATION_ERROR_0a00096e, "DS",
519 "%s: Image barrier 0x%p references image 0x%" PRIx64
520 " of format %s that must have the depth and stencil aspects set, but its "
521 "aspectMask is 0x%" PRIx32 ". %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200522 func_name, img_barrier, HandleToUint64(img_barrier->image), string_VkFormat(image_create_info->format),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600523 aspect_mask, validation_error_map[VALIDATION_ERROR_0a00096e]);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600524 }
525 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600526 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
527 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700528
Mike Weiblen62d08a32017-03-07 22:18:27 -0700529 for (uint32_t j = 0; j < level_count; j++) {
530 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
531 for (uint32_t k = 0; k < layer_count; k++) {
532 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
533 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
534 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
535 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
536 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700537 }
538 }
539 }
540 return skip;
541}
542
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700543void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
544 const VkImageMemoryBarrier *pImgMemBarriers) {
545 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700546
547 for (uint32_t i = 0; i < memBarrierCount; ++i) {
548 auto mem_barrier = &pImgMemBarriers[i];
549 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700550
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600551 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
552 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
553 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
554
555 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700556 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600557 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700558 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
559 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
560 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
561 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
562 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
563 }
564 }
565 }
566}
567
Tobin Ehlisc8266452017-04-07 12:20:30 -0600568bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600569 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600570 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700571 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600572 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600573 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700574
575 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
576 uint32_t layer = i + subLayers.baseArrayLayer;
577 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
578 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600579 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
580 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600581 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600582 // TODO: Improve log message in the next pass
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600583 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 +0200584 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600585 "%s: Cannot use image 0x%" PRIxLEAST64
586 " with specific layout %s that doesn't match the actual current layout %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +0200587 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout),
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600588 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600589 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700590 }
591 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600592 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
593 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
594 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700595 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
596 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600597 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200598 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer), __LINE__,
599 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600600 "%s: For optimal performance image 0x%" PRIxLEAST64 " layout should be %s instead of GENERAL.",
Petr Krausbc7f5442017-05-14 23:43:38 +0200601 caller, HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600603 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600604 if (image_state->shared_presentable) {
605 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
606 // TODO: Add unique error id when available.
607 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
608 __LINE__, msg_code, "DS",
609 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
610 string_VkImageLayout(optimal_layout));
611 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600612 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600614 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600615 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 +0200616 HandleToUint64(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600617 "%s: Layout for image 0x%" PRIxLEAST64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200618 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout),
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600619 string_VkImageLayout(optimal_layout), validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700620 }
621 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600622 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700623}
624
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700625void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
626 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700627 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700628 if (!renderPass) return;
629
630 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
631 if (framebuffer_state) {
632 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
633 auto image_view = framebuffer_state->createInfo.pAttachments[i];
634 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
635 }
636 }
637}
638
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700639bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700640 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600641 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700642 const debug_report_data *report_data = core_validation::GetReportData(device_data);
643
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600644 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600645 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 -0600646 VALIDATION_ERROR_09e0075e, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
647 validation_error_map[VALIDATION_ERROR_09e0075e]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600648
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600649 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600650 }
651
652 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
653
654 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
655 std::stringstream ss;
656 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600657 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 -0600658 VALIDATION_ERROR_09e007a2, "IMAGE", "%s. %s", ss.str().c_str(),
659 validation_error_map[VALIDATION_ERROR_09e007a2]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600660
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600661 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600662 }
663
664 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
665 std::stringstream ss;
666 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600667 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 -0600668 VALIDATION_ERROR_09e007ac, "IMAGE", "%s. %s", ss.str().c_str(),
669 validation_error_map[VALIDATION_ERROR_09e007ac]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600670
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600671 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600672 }
673
674 // Validate that format supports usage as color attachment
675 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
676 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
677 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
678 std::stringstream ss;
679 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
680 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600681 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
682 VALIDATION_ERROR_09e007b2, "IMAGE", "%s. %s", ss.str().c_str(),
683 validation_error_map[VALIDATION_ERROR_09e007b2]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600684 }
685 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
686 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
687 std::stringstream ss;
688 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
689 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
691 VALIDATION_ERROR_09e007a8, "IMAGE", "%s. %s", ss.str().c_str(),
692 validation_error_map[VALIDATION_ERROR_09e007a8]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600693 }
694 }
695
696 // Validate that format supports usage as depth/stencil attachment
697 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
698 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
699 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
700 std::stringstream ss;
701 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
702 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
704 VALIDATION_ERROR_09e007b4, "IMAGE", "%s. %s", ss.str().c_str(),
705 validation_error_map[VALIDATION_ERROR_09e007b4]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600706 }
707 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
708 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
709 std::stringstream ss;
710 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
711 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600712 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
713 VALIDATION_ERROR_09e007aa, "IMAGE", "%s. %s", ss.str().c_str(),
714 validation_error_map[VALIDATION_ERROR_09e007aa]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600715 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700716 }
717
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700718 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
719 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700720
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700721 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700722 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
Tobin Ehlisa55b1d42017-04-04 12:23:48 -0600723 // TODO : This is also covering 2918 & 2919. Break out into separate checks
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700724 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600725 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 -0600726 VALIDATION_ERROR_09e007b8, "Image",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600727 "CreateImage extent is 0 for at least one required dimension for image: "
728 "Width = %d Height = %d Depth = %d. %s",
729 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600730 validation_error_map[VALIDATION_ERROR_09e007b8]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700731 }
732
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600733 // TODO: VALIDATION_ERROR_09e00770 VALIDATION_ERROR_09e00772 VALIDATION_ERROR_09e00776 VALIDATION_ERROR_09e0076e
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700734 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700735 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
736 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
737 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
739 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
740 "CreateImage extents exceed allowable limits for format: "
741 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
742 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
743 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
744 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700745 }
746
Dave Houlton1150cf52017-04-27 14:38:11 -0600747 uint64_t totalSize =
748 ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height * (uint64_t)pCreateInfo->extent.depth *
749 (uint64_t)pCreateInfo->arrayLayers * (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format) +
750 (uint64_t)imageGranularity) &
751 ~(uint64_t)imageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700752
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700753 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600754 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
755 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
756 "CreateImage resource size exceeds allowable maximum "
757 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
758 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700759 }
760
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600761 // TODO: VALIDATION_ERROR_09e0077e
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700762 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600763 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
764 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
765 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
766 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700767 }
768
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700769 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600770 skip |=
771 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
772 VALIDATION_ERROR_09e00780, "Image",
773 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
774 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_09e00780]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700775 }
776
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700777 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600778 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 -0600779 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600780 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600781 validation_error_map[VALIDATION_ERROR_09e0078e]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700782 }
783
784 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600785 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 -0600786 VALIDATION_ERROR_09e0b801, "Image",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600787 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
788 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600789 validation_error_map[VALIDATION_ERROR_09e0b801]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700790 }
791
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600792 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600793 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 -0600794 VALIDATION_ERROR_09e00792, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600795 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
796 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600797 validation_error_map[VALIDATION_ERROR_09e00792]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600798 }
799
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600800 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600801 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
802 DRAWSTATE_INVALID_FEATURE, "DS",
803 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
804 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600805 }
806
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600807 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700808}
809
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700810void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700811 IMAGE_LAYOUT_NODE image_state;
812 image_state.layout = pCreateInfo->initialLayout;
813 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700814 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 -0700815 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700816 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
817 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700818}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700819
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700820bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700821 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700822 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200823 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700824 if (disabled->destroy_image) return false;
825 bool skip = false;
826 if (*image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600827 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700828 }
829 return skip;
830}
831
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700832void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700833 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
834 // Clean up memory mapping, bindings and range references for image
835 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700836 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700837 if (mem_info) {
838 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
839 }
840 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600841 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700842 // Remove image from imageMap
843 core_validation::GetImageMap(device_data)->erase(image);
844 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
845 core_validation::GetImageSubresourceMap(device_data);
846
847 const auto &sub_entry = imageSubresourceMap->find(image);
848 if (sub_entry != imageSubresourceMap->end()) {
849 for (const auto &pair : sub_entry->second) {
850 core_validation::GetImageLayoutMap(device_data)->erase(pair);
851 }
852 imageSubresourceMap->erase(sub_entry);
853 }
854}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700855
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700856bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700857 bool skip = false;
858 const debug_report_data *report_data = core_validation::GetReportData(device_data);
859
860 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
861 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
862 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 +0200863 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700864 }
865
Dave Houlton1d2022c2017-03-29 11:43:58 -0600866 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700867 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
868 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 -0600869 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
870 validation_error_map[VALIDATION_ERROR_1880000e]);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600871 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700872 char const str[] = "vkCmdClearColorImage called with compressed image.";
873 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 -0600874 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
875 validation_error_map[VALIDATION_ERROR_1880000e]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700876 }
877
878 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
879 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
880 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 -0600881 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s. %s", str,
882 validation_error_map[VALIDATION_ERROR_18800004]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700883 }
884 return skip;
885}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700886
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600887uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
888 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
889 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700890 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600891 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700892 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600893 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700894}
895
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600896uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
897 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
898 uint32_t array_layer_count = range->layerCount;
899 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
900 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700901 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600902 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700903}
904
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700905bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700906 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
907 bool skip = false;
908 const debug_report_data *report_data = core_validation::GetReportData(device_data);
909
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600910 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
911 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700912
913 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
914 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700915 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
916 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600917 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 +0200918 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700919 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
920 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600921 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600922 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600923 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600924 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 -0600925 HandleToUint64(image_state->image), __LINE__, 0, "DS",
926 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
927 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600928
929 } else {
930 if (image_state->shared_presentable) {
931 skip |= log_msg(
932 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600933 HandleToUint64(image_state->image), __LINE__, 0, "DS",
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600934 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
935 string_VkImageLayout(dest_image_layout));
936 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600937 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700938 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600939 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700940 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600941 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700942 } else {
943 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
944 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600945 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 +0200946 HandleToUint64(image_state->image), __LINE__, error_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600947 "%s: Layout for cleared image is %s but can only be "
948 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
949 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700950 }
951 }
952
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600953 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
954 uint32_t level = level_index + range.baseMipLevel;
955 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
956 uint32_t layer = layer_index + range.baseArrayLayer;
957 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700958 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700959 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700960 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600961 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700962 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600963 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700964 } else {
965 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
966 }
967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
968 __LINE__, error_code, "DS",
969 "%s: Cannot clear an image whose layout is %s and "
970 "doesn't match the current layout %s. %s",
971 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
972 validation_error_map[error_code]);
973 }
974 }
975 }
976 }
977
978 return skip;
979}
980
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700981void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
982 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600983 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
984 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
985 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700986
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600987 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
988 uint32_t level = level_index + range.baseMipLevel;
989 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
990 uint32_t layer = layer_index + range.baseArrayLayer;
991 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700992 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700993 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
994 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 -0700995 }
996 }
997 }
998}
999
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001000bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001001 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1002 bool skip = false;
1003 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001004 auto cb_node = GetCBNode(dev_data, commandBuffer);
1005 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001006 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001007 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001008 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001009 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001010 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001011 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001012 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001013 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Kraus8423f152017-05-26 01:20:04 +02001014 skip |=
1015 ValidateImageSubresourceRange(dev_data, image_state, false, pRanges[i], "vkCmdClearColorImage", param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001016 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001017 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001018 }
1019 }
1020 return skip;
1021}
1022
1023// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001024void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001025 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001026 auto cb_node = GetCBNode(dev_data, commandBuffer);
1027 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001028 if (cb_node && image_state) {
1029 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1030 std::function<bool()> function = [=]() {
1031 SetImageMemoryValid(dev_data, image_state, true);
1032 return false;
1033 };
1034 cb_node->validate_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001035 for (uint32_t i = 0; i < rangeCount; ++i) {
1036 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1037 }
1038 }
1039}
1040
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001041bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1042 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001043 const VkImageSubresourceRange *pRanges) {
1044 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001045 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1046
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001047 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001048 auto cb_node = GetCBNode(device_data, commandBuffer);
1049 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001050 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001051 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001052 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001053 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001054 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001055 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001056 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001057 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Kraus8423f152017-05-26 01:20:04 +02001058 skip |= ValidateImageSubresourceRange(device_data, image_state, false, pRanges[i], "vkCmdClearDepthStencilImage",
Petr Kraus4d718682017-05-18 03:38:41 +02001059 param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001060 skip |=
1061 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001062 // Image aspect must be depth or stencil or both
1063 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1064 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1065 char const str[] =
1066 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
1067 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
1068 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 +02001069 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001070 }
1071 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001072 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001073 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001074 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1075 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s. %s", str,
1076 validation_error_map[VALIDATION_ERROR_18a0001c]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001077 }
1078 }
1079 return skip;
1080}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001081
1082// Returns true if [x, xoffset] and [y, yoffset] overlap
1083static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1084 bool result = false;
1085 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1086 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1087
1088 if (intersection_max > intersection_min) {
1089 result = true;
1090 }
1091 return result;
1092}
1093
1094// Returns true if two VkImageCopy structures overlap
1095static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1096 bool result = false;
1097 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1098 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1099 dst->dstSubresource.layerCount))) {
1100 result = true;
1101 switch (type) {
1102 case VK_IMAGE_TYPE_3D:
1103 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1104 // Intentionally fall through to 2D case
1105 case VK_IMAGE_TYPE_2D:
1106 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1107 // Intentionally fall through to 1D case
1108 case VK_IMAGE_TYPE_1D:
1109 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1110 break;
1111 default:
1112 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1113 assert(false);
1114 }
1115 }
1116 return result;
1117}
1118
Dave Houltonfc1a4052017-04-27 14:32:45 -06001119// Returns non-zero if offset and extent exceed image extents
1120static const uint32_t x_bit = 1;
1121static const uint32_t y_bit = 2;
1122static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001123static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001124 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001125 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001126 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1127 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001128 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001129 }
1130 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1131 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001132 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001133 }
1134 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1135 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001136 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001137 }
1138 return result;
1139}
1140
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001141// Test if two VkExtent3D structs are equivalent
1142static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1143 bool result = true;
1144 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1145 (extent->depth != other_extent->depth)) {
1146 result = false;
1147 }
1148 return result;
1149}
1150
Dave Houlton6f9059e2017-05-02 17:15:13 -06001151// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001152static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1153 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001154
1155 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001156 if (mip >= img->createInfo.mipLevels) {
1157 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001158 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001159
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001160 // 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 -06001161 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001162 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1163 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1164 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001165
Dave Houlton6f9059e2017-05-02 17:15:13 -06001166 // Image arrays have an effective z extent that isn't diminished by mip level
1167 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001168 extent.depth = img->createInfo.arrayLayers;
1169 }
1170
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001171 return extent;
1172}
1173
1174// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001175static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001176 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1177}
1178
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001179// Test if the extent argument has any dimensions set to 0.
1180static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1181 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1182}
1183
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001184// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1185static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1186 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1187 VkExtent3D granularity = {0, 0, 0};
1188 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1189 if (pPool) {
1190 granularity =
1191 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001192 if (FormatIsCompressed(img->createInfo.format)) {
1193 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001194 granularity.width *= block_size.width;
1195 granularity.height *= block_size.height;
1196 }
1197 }
1198 return granularity;
1199}
1200
1201// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1202static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1203 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001204 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1205 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001206 valid = false;
1207 }
1208 return valid;
1209}
1210
1211// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1212static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1213 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1214 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1215 bool skip = false;
1216 VkExtent3D offset_extent = {};
1217 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1218 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1219 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001220 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001221 // 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 -07001222 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001223 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1224 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1225 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1226 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1227 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001228 }
1229 } else {
1230 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1231 // integer multiples of the image transfer granularity.
1232 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001233 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1234 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1235 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1236 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1237 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1238 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001239 }
1240 }
1241 return skip;
1242}
1243
1244// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1245static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1246 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1247 const uint32_t i, const char *function, const char *member) {
1248 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1249 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001250 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001251 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1252 // subresource extent.
1253 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001254 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1255 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1256 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1257 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1258 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1259 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001260 }
1261 } else {
1262 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1263 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1264 // subresource extent dimensions.
1265 VkExtent3D offset_extent_sum = {};
1266 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1267 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1268 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001269
1270 bool x_ok =
1271 ((0 == SafeModulo(extent->width, granularity->width)) || (subresource_extent->width == offset_extent_sum.width));
1272 bool y_ok =
1273 ((0 == SafeModulo(extent->height, granularity->height)) || (subresource_extent->height == offset_extent_sum.height));
1274 bool z_ok =
1275 ((0 == SafeModulo(extent->depth, granularity->depth)) || (subresource_extent->depth == offset_extent_sum.depth));
1276
1277 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001278 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001279 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 +02001280 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001281 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1282 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1283 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1284 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1285 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1286 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1287 }
1288 }
1289 return skip;
1290}
1291
1292// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1293static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1294 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1295 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1296
1297 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001298 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001299 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 +02001300 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001301 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1302 "transfer granularity width (%d).",
1303 function, i, member, value, granularity);
1304 }
1305 return skip;
1306}
1307
1308// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1309static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1310 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1311 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1312 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001313 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001314 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 +02001315 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001316 "%s: pRegion[%d].%s (%" PRIdLEAST64
1317 ") must be an even integer multiple of this command buffer's queue family image transfer "
1318 "granularity width (%d).",
1319 function, i, member, value, granularity);
1320 }
1321 return skip;
1322}
1323
1324// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1325bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1326 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1327 const uint32_t i, const char *function) {
1328 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001329 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001330 // TODO: Add granularity checking for compressed formats
1331
1332 // bufferRowLength must be a multiple of the compressed texel block width
1333 // bufferImageHeight must be a multiple of the compressed texel block height
1334 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1335 // bufferOffset must be a multiple of the compressed texel block size in bytes
1336 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1337 // must equal the image subresource width
1338 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1339 // must equal the image subresource height
1340 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1341 // must equal the image subresource depth
1342 } else {
1343 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1344 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1345 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1346 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1347 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1348 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1349 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1350 i, function, "imageExtent");
1351 }
1352 return skip;
1353}
1354
1355// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1356bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001357 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1358 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001359 bool skip = false;
Dave Houlton6f9059e2017-05-02 17:15:13 -06001360 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001361 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001362 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
1363 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->srcOffset, &granularity, &subresource_extent, i,
1364 function, "extent");
1365
1366 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001367 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001368 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001369 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1370 function, "extent");
1371 return skip;
1372}
1373
Dave Houlton6f9059e2017-05-02 17:15:13 -06001374// Validate contents of a VkImageCopy struct
1375bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1376 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1377 bool skip = false;
1378
1379 for (uint32_t i = 0; i < regionCount; i++) {
1380 VkImageCopy image_copy = ic_regions[i];
1381 bool slice_override = false;
1382 uint32_t depth_slices = 0;
1383
1384 // Special case for copying between a 1D/2D array and a 3D image
1385 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1386 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
1387 depth_slices = image_copy.dstSubresource.layerCount; // Slice count from 2D subresource
1388 slice_override = (depth_slices != 1);
1389 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
1390 depth_slices = image_copy.srcSubresource.layerCount; // Slice count from 2D subresource
1391 slice_override = (depth_slices != 1);
1392 }
1393
1394 // Do all checks on source image
1395 //
1396 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
1397 if ((0 != image_copy.srcOffset.y) || (1 != image_copy.extent.height)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001398 skip |=
1399 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1400 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1401 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1402 "be 0 and 1, respectively. %s",
1403 i, image_copy.srcOffset.y, image_copy.extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001404 }
1405 }
1406
1407 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (src_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
1408 if ((0 != image_copy.srcOffset.z) || (1 != image_copy.extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001409 skip |=
1410 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1411 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00128, "IMAGE",
1412 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1413 "these must be 0 and 1, respectively. %s",
1414 i, image_copy.srcOffset.z, image_copy.extent.depth, validation_error_map[VALIDATION_ERROR_09c00128]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001415 }
1416 }
1417
1418 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001419 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001420 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1421 if ((0 != image_copy.srcSubresource.baseArrayLayer) || (1 != image_copy.srcSubresource.layerCount)) {
1422 skip |=
1423 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001424 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001425 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1426 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1427 i, image_copy.srcSubresource.baseArrayLayer, image_copy.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001428 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001429 }
1430 }
1431 } else { // Pre maint 1
1432 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1433 if ((0 != image_copy.srcSubresource.baseArrayLayer) || (1 != image_copy.srcSubresource.layerCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001434 skip |=
1435 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1436 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1437 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1438 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1439 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
1440 i, image_copy.srcSubresource.baseArrayLayer, image_copy.srcSubresource.layerCount,
1441 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001442 }
1443 }
1444 }
1445
1446 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
1447 if ((image_copy.srcSubresource.baseArrayLayer >= src_state->createInfo.arrayLayers) ||
1448 (image_copy.srcSubresource.baseArrayLayer + image_copy.srcSubresource.layerCount > src_state->createInfo.arrayLayers)) {
1449 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 -06001450 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0012a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001451 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer (%d) must be less than the source image's "
1452 "arrayLayers (%d), and the sum of baseArrayLayer and srcSubresource.layerCount (%d) must be less than "
1453 "or equal to the source image's arrayLayers. %s",
1454 i, image_copy.srcSubresource.baseArrayLayer, src_state->createInfo.arrayLayers,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001455 image_copy.srcSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c0012a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001456 }
1457
1458 // Checks that apply only to compressed images
1459 if (FormatIsCompressed(src_state->createInfo.format)) {
1460 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
1461
1462 // image offsets must be multiples of block dimensions
1463 if ((SafeModulo(image_copy.srcOffset.x, block_size.width) != 0) ||
1464 (SafeModulo(image_copy.srcOffset.y, block_size.height) != 0) ||
1465 (SafeModulo(image_copy.srcOffset.z, block_size.depth) != 0)) {
1466 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 -06001467 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001468 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1469 "texel width & height (%d, %d). %s.",
1470 i, image_copy.srcOffset.x, image_copy.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001471 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001472 }
1473
1474 // extent width must be a multiple of block width, or extent+offset width must equal subresource width
1475 VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(image_copy.srcSubresource));
1476 if ((SafeModulo(image_copy.extent.width, block_size.width) != 0) &&
1477 (image_copy.extent.width + image_copy.srcOffset.x != mip_extent.width)) {
1478 skip |=
1479 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001480 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001481 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1482 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
1483 i, image_copy.extent.width, block_size.width, image_copy.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001484 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001485 }
1486
1487 // extent height must be a multiple of block height, or extent+offset height must equal subresource height
1488 if ((SafeModulo(image_copy.extent.height, block_size.height) != 0) &&
1489 (image_copy.extent.height + image_copy.srcOffset.y != mip_extent.height)) {
1490 skip |=
1491 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001492 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001493 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1494 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
1495 i, image_copy.extent.height, block_size.height, image_copy.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001496 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001497 }
1498
1499 // extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
1500 uint32_t copy_depth = (slice_override ? depth_slices : image_copy.extent.depth);
1501 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + image_copy.srcOffset.z != mip_extent.depth)) {
1502 skip |=
1503 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001504 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001505 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1506 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
1507 i, image_copy.extent.depth, block_size.depth, image_copy.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001508 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001509 }
1510 } // Compressed
1511
1512 // Do all checks on dest image
1513 //
1514 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
1515 if ((0 != image_copy.dstOffset.y) || (1 != image_copy.extent.height)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001516 skip |=
1517 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1518 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1519 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and extent.height is %d. For 1D images these must "
1520 "be 0 and 1, respectively. %s",
1521 i, image_copy.dstOffset.y, image_copy.extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001522 }
1523 }
1524
1525 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
1526 if ((0 != image_copy.dstOffset.z) || (1 != image_copy.extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001527 skip |=
1528 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1529 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00134, "IMAGE",
1530 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1531 "these must be 0 and 1, respectively. %s",
1532 i, image_copy.dstOffset.z, image_copy.extent.depth, validation_error_map[VALIDATION_ERROR_09c00134]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001533 }
1534 }
1535
1536 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1537 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
1538 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 -06001539 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001540 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1541 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1542 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001543 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001544 }
1545 }
1546 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001547 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001548 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1549 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
1550 skip |=
1551 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001552 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001553 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1554 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1555 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001556 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001557 }
1558 }
1559 } else { // Pre maint 1
1560 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1561 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001562 skip |=
1563 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1564 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1565 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1566 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1567 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
1568 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
1569 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001570 }
1571 }
1572 }
1573
1574 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
1575 if ((image_copy.dstSubresource.baseArrayLayer >= dst_state->createInfo.arrayLayers) ||
1576 (image_copy.dstSubresource.baseArrayLayer + image_copy.dstSubresource.layerCount > dst_state->createInfo.arrayLayers)) {
1577 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 -06001578 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00136, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001579 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer (%d) must be less than the dest image's "
1580 "arrayLayers (%d), and the sum of baseArrayLayer and dstSubresource.layerCount (%d) must be less than "
1581 "or equal to the dest image's arrayLayers. %s",
1582 i, image_copy.dstSubresource.baseArrayLayer, dst_state->createInfo.arrayLayers,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001583 image_copy.dstSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c00136]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001584 }
1585
1586 // Checks that apply only to compressed images
1587 if (FormatIsCompressed(dst_state->createInfo.format)) {
1588 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
1589
1590 // image offsets must be multiples of block dimensions
1591 if ((SafeModulo(image_copy.dstOffset.x, block_size.width) != 0) ||
1592 (SafeModulo(image_copy.dstOffset.y, block_size.height) != 0) ||
1593 (SafeModulo(image_copy.dstOffset.z, block_size.depth) != 0)) {
1594 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 -06001595 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001596 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1597 "texel width & height (%d, %d). %s.",
1598 i, image_copy.dstOffset.x, image_copy.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001599 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001600 }
1601
1602 // extent width must be a multiple of block width, or extent+offset width must equal subresource width
1603 VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(image_copy.dstSubresource));
1604 if ((SafeModulo(image_copy.extent.width, block_size.width) != 0) &&
1605 (image_copy.extent.width + image_copy.dstOffset.x != mip_extent.width)) {
1606 skip |=
1607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001608 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001609 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1610 "width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
1611 i, image_copy.extent.width, block_size.width, image_copy.dstOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001612 validation_error_map[VALIDATION_ERROR_09c00146]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001613 }
1614
1615 // extent height must be a multiple of block height, or extent+offset height must equal subresource height
1616 if ((SafeModulo(image_copy.extent.height, block_size.height) != 0) &&
1617 (image_copy.extent.height + image_copy.dstOffset.y != mip_extent.height)) {
1618 skip |=
1619 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001620 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001621 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1622 "height (%d), or when added to dstOffset.y (%d) must equal the image subresource height (%d). %s.",
1623 i, image_copy.extent.height, block_size.height, image_copy.dstOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001624 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001625 }
1626
1627 // extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
1628 uint32_t copy_depth = (slice_override ? depth_slices : image_copy.extent.depth);
1629 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + image_copy.dstOffset.z != mip_extent.depth)) {
1630 skip |=
1631 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001632 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001633 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1634 "depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1635 i, image_copy.extent.depth, block_size.depth, image_copy.dstOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001636 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001637 }
1638 } // Compressed
1639 }
1640 return skip;
1641}
1642
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001643bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001644 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1645 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001646 bool skip = false;
1647 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001648 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1649
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001650 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1651
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001652 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001653 bool slice_override = false;
1654 uint32_t depth_slices = 0;
1655
1656 // Special case for copying between a 1D/2D array and a 3D image
1657 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1658 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1659 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
1660 depth_slices = regions[i].dstSubresource.layerCount; // Slice count from 2D subresource
1661 slice_override = (depth_slices != 1);
1662 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1663 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
1664 depth_slices = regions[i].srcSubresource.layerCount; // Slice count from 2D subresource
1665 slice_override = (depth_slices != 1);
1666 }
1667
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001668 if (regions[i].srcSubresource.layerCount == 0) {
1669 std::stringstream ss;
1670 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001671 skip |=
1672 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1673 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001674 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001675
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001676 if (regions[i].dstSubresource.layerCount == 0) {
1677 std::stringstream ss;
1678 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001679 skip |=
1680 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1681 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001682 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001683
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001684 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001685 // No chance of mismatch if we're overriding depth slice count
1686 if (!slice_override) {
1687 // The number of depth slices in srcSubresource and dstSubresource must match
1688 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1689 uint32_t src_slices =
1690 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? regions[i].extent.depth
1691 : regions[i].srcSubresource.layerCount);
1692 uint32_t dst_slices =
1693 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? regions[i].extent.depth
1694 : regions[i].dstSubresource.layerCount);
1695 if (src_slices != dst_slices) {
1696 std::stringstream ss;
1697 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1698 << "] do not match";
1699 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 -06001700 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE",
1701 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001702 }
1703 }
1704 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001705 // For each region the layerCount member of srcSubresource and dstSubresource must match
1706 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1707 std::stringstream ss;
1708 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1709 << "] do not match";
1710 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 -06001711 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1712 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001713 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001714 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001715
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001716 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1717 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1718 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1719 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 -06001720 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1721 validation_error_map[VALIDATION_ERROR_09c00112]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001722 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001723
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001724 // For each region, the aspectMask member of srcSubresource must be present in the source image
1725 if (!VerifyAspectsPresent(regions[i].srcSubresource.aspectMask, src_image_state->createInfo.format)) {
1726 std::stringstream ss;
1727 ss << "vkCmdCopyImage: pRegion[" << i
1728 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1729 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 -06001730 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1731 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001732 }
1733
1734 // For each region, the aspectMask member of dstSubresource must be present in the destination image
1735 if (!VerifyAspectsPresent(regions[i].dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
1736 std::stringstream ss;
1737 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1738 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 -06001739 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1740 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001741 }
1742
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001743 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1744 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1745 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1746 std::stringstream ss;
1747 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1748 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 -06001749 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1750 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001751 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001752
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001753 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1754 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1755 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1756 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1757 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1758 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 -06001759 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s. %s", str,
1760 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001761 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001762
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001763 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1764 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1765 std::stringstream ss;
1766 ss << "vkCmdCopyImage: pRegions[" << i
1767 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1768 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 -06001769 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1770 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001771 }
1772 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1773 std::stringstream ss;
1774 ss << "vkCmdCopyImage: pRegions[" << i
1775 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1776 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 -06001777 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1778 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001779 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001780
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001781 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1782 // image was created
1783 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1784 src_image_state->createInfo.arrayLayers) {
1785 std::stringstream ss;
1786 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1787 << "] baseArrayLayer + layerCount is "
1788 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1789 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 -06001790 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1791 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001792 }
1793 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1794 dst_image_state->createInfo.arrayLayers) {
1795 std::stringstream ss;
1796 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1797 << "] baseArrayLayer + layerCount is "
1798 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1799 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 -06001800 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1801 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001802 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001803
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001804 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1805 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1806 // The source region specified by a given element of regions must be a region that is contained within srcImage
Dave Houltonfc1a4052017-04-27 14:32:45 -06001807 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(regions[i].srcSubresource));
1808 if (0 != ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001809 std::stringstream ss;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001810 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << regions[i].srcSubresource.mipLevel
1811 << " ], offset [ " << regions[i].srcOffset.x << ", " << regions[i].srcOffset.y << ", " << regions[i].srcOffset.z
1812 << " ], extent [ " << regions[i].extent.width << ", " << regions[i].extent.height << ", "
1813 << regions[i].extent.depth << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001814 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 -06001815 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s. %s",
1816 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001817 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001818
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001819 // The destination region specified by a given element of regions must be a region that is contained within dst_image
Dave Houltonfc1a4052017-04-27 14:32:45 -06001820 img_extent = GetImageSubresourceExtent(dst_image_state, &(regions[i].dstSubresource));
1821 if (0 != ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001822 std::stringstream ss;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001823 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << regions[i].dstSubresource.mipLevel
1824 << " ], offset [ " << regions[i].dstOffset.x << ", " << regions[i].dstOffset.y << ", " << regions[i].dstOffset.z
1825 << " ], extent [ " << regions[i].extent.width << ", " << regions[i].extent.height << ", "
1826 << regions[i].extent.depth << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001827 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 -06001828 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1829 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001830 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001831 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001832
Dave Houltonfc1a4052017-04-27 14:32:45 -06001833 // Each dimension offset + extent limits must fall with image subresource extent
1834 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(regions[i].srcSubresource));
Dave Houlton6f9059e2017-05-02 17:15:13 -06001835 VkExtent3D copy_extent = regions[i].extent;
1836 if (slice_override) copy_extent.depth = depth_slices;
1837 uint32_t extent_check = ExceedsBounds(&(regions[i].srcOffset), &copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001838 if (extent_check & x_bit) {
1839 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 -06001840 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001841 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1842 "width [%1d]. %s",
1843 i, regions[i].srcOffset.x, regions[i].extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001844 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001845 }
1846
1847 if (extent_check & y_bit) {
1848 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 -06001849 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001850 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1851 "height [%1d]. %s",
1852 i, regions[i].srcOffset.y, regions[i].extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001853 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001854 }
1855 if (extent_check & z_bit) {
1856 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 -06001857 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001858 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1859 "depth [%1d]. %s",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001860 i, regions[i].srcOffset.z, copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001861 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001862 }
1863
1864 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(regions[i].dstSubresource));
Dave Houlton6f9059e2017-05-02 17:15:13 -06001865 copy_extent = regions[i].extent;
1866 if (slice_override) copy_extent.depth = depth_slices;
1867 extent_check = ExceedsBounds(&(regions[i].dstOffset), &copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001868 if (extent_check & x_bit) {
1869 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001870 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001871 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1872 "width [%1d]. %s",
1873 i, regions[i].dstOffset.x, regions[i].extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001874 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001875 }
1876 if (extent_check & y_bit) {
1877 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 -06001878 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001879 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1880 "height [%1d]. %s",
1881 i, regions[i].dstOffset.y, regions[i].extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001882 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001883 }
1884 if (extent_check & z_bit) {
1885 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 -06001886 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001887 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1888 "depth [%1d]. %s",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001889 i, regions[i].dstOffset.z, copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001890 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001891 }
1892
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001893 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1894 // must not overlap in memory
1895 if (src_image_state->image == dst_image_state->image) {
1896 for (uint32_t j = 0; j < region_count; j++) {
1897 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1898 std::stringstream ss;
1899 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1900 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001901 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
1902 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001903 }
1904 }
1905 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001906 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001907
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001908 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1909 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1910 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06001911 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001912 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1913 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02001914 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1915 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001916 }
1917 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06001918 size_t srcSize = FormatSize(src_image_state->createInfo.format);
1919 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001920 if (srcSize != destSize) {
1921 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1922 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 -06001923 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
1924 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001925 }
1926 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001927
Dave Houlton33c22b72017-02-28 13:16:02 -07001928 // Source and dest image sample counts must match
1929 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
1930 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
1931 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001932 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
1933 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07001934 }
1935
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001936 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
1937 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001938 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001939 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001940 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001941 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001942 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001943 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001944 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001945 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001946 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06001947 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001948 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001949 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001950 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001951 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001952 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001953 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
1954 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001955 }
1956
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001957 return skip;
1958}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001959
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001960void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001961 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1962 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
1963 // Make sure that all image slices are updated to correct layout
1964 for (uint32_t i = 0; i < region_count; ++i) {
1965 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
1966 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
1967 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001968 // Update bindings between images and cmd buffer
1969 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1970 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07001971 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001972 cb_node->validate_functions.push_back(function);
1973 function = [=]() {
1974 SetImageMemoryValid(device_data, dst_image_state, true);
1975 return false;
1976 };
1977 cb_node->validate_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001978}
1979
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001980// Returns true if sub_rect is entirely contained within rect
1981static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1982 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1983 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1984 return false;
1985 return true;
1986}
1987
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001988bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1989 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001990 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001991 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1992
1993 bool skip = false;
1994 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001995 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
1996 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001997 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001998 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07001999 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002000 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2001 // 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 -07002002 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2003 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002004 skip |=
2005 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 +02002006 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002007 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
2008 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2009 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002010 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002011 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002012 }
2013
2014 // Validate that attachment is in reference list of active subpass
2015 if (cb_node->activeRenderPass) {
2016 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2017 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002018 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002019
2020 for (uint32_t i = 0; i < attachmentCount; i++) {
2021 auto clear_desc = &pAttachments[i];
2022 VkImageView image_view = VK_NULL_HANDLE;
2023
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002024 if (0 == clear_desc->aspectMask) {
2025 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 -06002026 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2027 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002028 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2029 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 -06002030 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2031 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002032 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002033 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002034 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2035 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2036 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2037 clear_desc->colorAttachment, cb_node->activeSubpass,
2038 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002039 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2040 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002041 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2042 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002043 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2044 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002045 } else {
2046 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002047 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002048 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002049 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2050 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2051 char const str[] =
2052 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
2053 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 -06002054 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2055 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002056 }
2057 } else { // Must be depth and/or stencil
2058 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2059 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2060 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
2061 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 -06002062 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2063 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002064 }
2065 if (!subpass_desc->pDepthStencilAttachment ||
2066 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2067 skip |= log_msg(
2068 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002069 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002070 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002071 } else {
2072 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2073 }
2074 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002075 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002076 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002077 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002078 // The rectangular region specified by a given element of pRects must be contained within the render area of
2079 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002080 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
2081 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
2082 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002083 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 -06002084 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002085 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2086 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002087 j, validation_error_map[VALIDATION_ERROR_18600020]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002088 }
2089 // The layers specified by a given element of pRects must be contained within every attachment that
2090 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002091 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002092 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2093 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002094 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002095 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 -06002096 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002097 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
2098 "pAttachment[%d]. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002099 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002100 }
2101 }
2102 }
2103 }
2104 }
2105 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002106}
2107
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002108bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002109 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002110 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002111 bool skip = false;
2112 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002113 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2114 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2115 skip |=
2116 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002117 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002118 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002119
2120 // For each region, the number of layers in the image subresource should not be zero
2121 // For each region, src and dest image aspect must be color only
2122 for (uint32_t i = 0; i < regionCount; i++) {
2123 if (pRegions[i].srcSubresource.layerCount == 0) {
2124 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002125 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 +02002126 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002127 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002128 if (pRegions[i].dstSubresource.layerCount == 0) {
2129 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002130 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 +02002131 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002132 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002133 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2134 skip |= log_msg(
2135 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002136 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002137 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002138 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002139 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002140 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2141 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2142 char const str[] =
2143 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2144 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 -06002145 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2146 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002147 }
2148 }
2149
2150 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2151 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002152 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 +02002153 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002154 }
2155 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2156 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002157 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 +02002158 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002159 }
2160 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2161 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2162 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 -06002163 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2164 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002165 }
2166 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2167 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2168 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 -06002169 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2170 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002171 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002172 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002173 } else {
2174 assert(0);
2175 }
2176 return skip;
2177}
2178
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002179void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2180 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002181 // Update bindings between images and cmd buffer
2182 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2183 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2184
2185 std::function<bool()> function = [=]() {
2186 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2187 };
2188 cb_node->validate_functions.push_back(function);
2189 function = [=]() {
2190 SetImageMemoryValid(device_data, dst_image_state, true);
2191 return false;
2192 };
2193 cb_node->validate_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002194}
2195
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002196bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002197 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
2198 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2199
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002200 bool skip = false;
2201 if (cb_node && src_image_state && dst_image_state) {
2202 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002203 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002204 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002205 VALIDATION_ERROR_184001d4);
2206 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2207 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2208 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2209 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2210 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2211 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2212 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002213 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002214 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002215 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002216
Dave Houlton33c2d252017-06-09 17:08:32 -06002217 VkFormat src_format = src_image_state->createInfo.format;
2218 VkFormat dst_format = dst_image_state->createInfo.format;
2219 VkImageType src_type = src_image_state->createInfo.imageType;
2220 VkImageType dst_type = dst_image_state->createInfo.imageType;
2221
2222 const VkFormatProperties *props = GetFormatProperties(device_data, src_format);
2223 VkImageTiling tiling = src_image_state->createInfo.tiling;
2224 VkFormatFeatureFlags flags =
2225 (tiling == VK_IMAGE_TILING_LINEAR ? props->linearTilingFeatures : props->optimalTilingFeatures);
2226 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2227 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2228 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2229 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2230 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2231 }
2232
2233 if ((VK_FILTER_LINEAR == filter) &&
2234 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2235 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2236 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2237 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2238 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2239 }
2240
2241 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2242 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
2243 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2244 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2245 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2246 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2247 }
2248
2249 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2250 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2251 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2252 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2253 validation_error_map[VALIDATION_ERROR_184001da]);
2254 }
2255
2256 props = GetFormatProperties(device_data, dst_format);
2257 tiling = dst_image_state->createInfo.tiling;
2258 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props->linearTilingFeatures : props->optimalTilingFeatures);
2259 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2260 skip |=
2261 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2262 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2263 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2264 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2265 }
2266
2267 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2268 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2269 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2270 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2271 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2272 validation_error_map[VALIDATION_ERROR_184001c8]);
2273 }
2274
2275 // Validate consistency for unsigned formats
2276 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2277 std::stringstream ss;
2278 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2279 << "the other one must also have unsigned integer format. "
2280 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2281 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2282 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2283 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2284 }
2285
2286 // Validate consistency for signed formats
2287 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2288 std::stringstream ss;
2289 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2290 << "the other one must also have signed integer format. "
2291 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2292 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2293 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2294 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2295 }
2296
2297 // Validate filter for Depth/Stencil formats
2298 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2299 std::stringstream ss;
2300 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2301 << "then filter must be VK_FILTER_NEAREST.";
2302 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2303 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d0, "IMAGE", "%s. %s",
2304 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2305 }
2306
2307 // Validate aspect bits and formats for depth/stencil images
2308 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2309 if (src_format != dst_format) {
2310 std::stringstream ss;
2311 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2312 << "stencil, the other one must have exactly the same format. "
2313 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2314 << string_VkFormat(dst_format);
2315 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2316 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2317 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2318 }
2319
2320#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2321 for (uint32_t i = 0; i < regionCount; i++) {
2322 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2323
2324 if (FormatIsDepthAndStencil(src_format)) {
2325 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2326 std::stringstream ss;
2327 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
2328 "VK_IMAGE_ASPECT_DEPTH_BIT "
2329 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2330 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2331 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2332 "%s", ss.str().c_str());
2333 }
2334 }
2335 else if (FormatIsStencilOnly(src_format)) {
2336 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2337 std::stringstream ss;
2338 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2339 << "set in both the srcImage and dstImage";
2340 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2341 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2342 "%s", ss.str().c_str());
2343 }
2344 }
2345 else if (FormatIsDepthOnly(src_format)) {
2346 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2347 std::stringstream ss;
2348 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2349 << "set in both the srcImage and dstImage";
2350 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2351 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2352 "%s", ss.str().c_str());
2353 }
2354 }
2355 }
2356#endif
2357 } // Depth or Stencil
2358
2359 // Do per-region checks
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002360 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton48989f32017-05-26 15:01:46 -06002361 VkImageBlit rgn = pRegions[i];
2362
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002363 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002364 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2365 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002366 std::stringstream ss;
2367 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2368 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 +02002369 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2370 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002371 }
Dave Houlton48989f32017-05-26 15:01:46 -06002372 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2373 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002374 std::stringstream ss;
2375 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2376 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 +02002377 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2378 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002379 }
Dave Houlton48989f32017-05-26 15:01:46 -06002380 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002381 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2382 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 +02002383 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002384 }
Dave Houlton48989f32017-05-26 15:01:46 -06002385 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002386 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2387 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 +02002388 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002389 }
2390
2391 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002392 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002393 skip |=
2394 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 -06002395 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002396 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002397 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002398 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002399
Dave Houlton48989f32017-05-26 15:01:46 -06002400 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002401 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 -06002402 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002403 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002404 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002405 }
Dave Houlton48989f32017-05-26 15:01:46 -06002406
Dave Houlton33c2d252017-06-09 17:08:32 -06002407 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2408 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2409 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2410 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2411 "image format %s. %s",
2412 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2413 validation_error_map[VALIDATION_ERROR_09a001e2]);
2414 }
2415
2416 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2417 skip |= log_msg(
2418 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2419 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2420 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2421 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2422 }
2423
Dave Houlton48989f32017-05-26 15:01:46 -06002424 // Validate source image offsets
2425 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002426 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002427 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2428 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2429 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2430 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2431 "of (%1d, %1d). These must be (0, 1). %s",
2432 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2433 }
2434 }
2435
Dave Houlton33c2d252017-06-09 17:08:32 -06002436 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002437 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2438 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2439 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2440 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2441 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2442 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2443 }
2444 }
2445
Dave Houlton33c2d252017-06-09 17:08:32 -06002446 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002447 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2448 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002449 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002450 skip |= log_msg(
2451 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2452 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2453 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2454 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2455 }
2456 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2457 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002458 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002459 skip |= log_msg(
2460 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2461 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2462 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2463 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2464 }
2465 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2466 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002467 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002468 skip |= log_msg(
2469 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2470 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2471 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2472 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2473 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002474 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2475 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2476 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2477 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2478 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2479 } else if (oob) {
2480 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2481 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2482 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2483 validation_error_map[VALIDATION_ERROR_184001ae]);
2484 }
Dave Houlton48989f32017-05-26 15:01:46 -06002485
2486 // Validate dest image offsets
2487 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002488 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002489 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2490 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2491 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2492 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2493 "(%1d, %1d). These must be (0, 1). %s",
2494 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2495 }
2496 }
2497
Dave Houlton33c2d252017-06-09 17:08:32 -06002498 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002499 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2500 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2501 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2502 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2503 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2504 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2505 }
2506 }
2507
Dave Houlton33c2d252017-06-09 17:08:32 -06002508 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002509 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2510 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002511 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002512 skip |= log_msg(
2513 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2514 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2515 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2516 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2517 }
2518 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2519 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002520 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002521 skip |= log_msg(
2522 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2523 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2524 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2525 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2526 }
2527 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2528 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002529 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002530 skip |= log_msg(
2531 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2532 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2533 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2534 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2535 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002536 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002537 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 -06002538 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2539 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2540 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2541 } else if (oob) {
2542 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2543 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2544 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2545 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002546 }
2547
Dave Houlton33c2d252017-06-09 17:08:32 -06002548 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2549 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2550 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2551 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2552 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2553 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2554 "layerCount other than 1. %s",
2555 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002556 }
2557 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002558 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002559 } else {
2560 assert(0);
2561 }
2562 return skip;
2563}
2564
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002565void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2566 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002567 // Update bindings between images and cmd buffer
2568 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2569 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2570
2571 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
2572 cb_node->validate_functions.push_back(function);
2573 function = [=]() {
2574 SetImageMemoryValid(device_data, dst_image_state, true);
2575 return false;
2576 };
2577 cb_node->validate_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002578}
2579
Tony Barbourdf013b92017-01-25 12:53:48 -07002580// This validates that the initial layout specified in the command buffer for
2581// the IMAGE is the same
2582// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002583bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002584 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const & globalImageLayoutMap,
2585 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> & overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002586 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002587 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002588 for (auto cb_image_data : pCB->imageLayoutMap) {
2589 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002590
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002591 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
2592 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002593 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2594 // TODO: Set memory invalid which is in mem_tracker currently
2595 } else if (imageLayout != cb_image_data.second.initialLayout) {
2596 if (cb_image_data.first.hasSubresource) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002597 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2598 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2599 "Cannot submit cmd buffer using image (0x%" PRIx64
2600 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
2601 "with layout %s when first use is %s.",
2602 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2603 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2604 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002605 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002606 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2607 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2608 "Cannot submit cmd buffer using image (0x%" PRIx64
2609 ") with layout %s when "
2610 "first use is %s.",
2611 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2612 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002613 }
2614 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002615 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002616 }
2617 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002618 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002619}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002620
Tony Barbourdf013b92017-01-25 12:53:48 -07002621void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2622 for (auto cb_image_data : pCB->imageLayoutMap) {
2623 VkImageLayout imageLayout;
2624 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2625 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2626 }
2627}
2628
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002629// Print readable FlagBits in FlagMask
2630static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2631 std::string result;
2632 std::string separator;
2633
2634 if (accessMask == 0) {
2635 result = "[None]";
2636 } else {
2637 result = "[";
2638 for (auto i = 0; i < 32; i++) {
2639 if (accessMask & (1 << i)) {
2640 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2641 separator = " | ";
2642 }
2643 }
2644 result = result + "]";
2645 }
2646 return result;
2647}
2648
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002649// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2650// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002651// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002652static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2653 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2654 const char *type) {
2655 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2656 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002657
2658 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2659 if (accessMask & ~(required_bit | optional_bits)) {
2660 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002661 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 +02002662 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002663 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2664 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002665 }
2666 } else {
2667 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002668 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 +02002669 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002670 "%s AccessMask %d %s must contain at least one of access bits %d "
2671 "%s when layout is %s, unless the app has previously added a "
2672 "barrier for this transition.",
2673 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2674 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002675 } else {
2676 std::string opt_bits;
2677 if (optional_bits != 0) {
2678 std::stringstream ss;
2679 ss << optional_bits;
2680 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2681 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002682 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 +02002683 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002684 "%s AccessMask %d %s must have required access bit %d %s %s when "
2685 "layout is %s, unless the app has previously added a barrier for "
2686 "this transition.",
2687 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2688 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002689 }
2690 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002691 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002692}
2693
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002694bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
2695 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
2696 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002697
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002698 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002699 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002700 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
2701 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
2702 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2703 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002704 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002705 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
2706 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
2707 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2708 break;
2709 }
2710 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
2711 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
2712 break;
2713 }
2714 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
2715 skip |= ValidateMaskBits(
2716 device_data, cmdBuffer, accessMask, layout, 0,
2717 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
2718 type);
2719 break;
2720 }
2721 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
2722 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
2723 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
2724 break;
2725 }
2726 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
2727 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
2728 break;
2729 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002730 case VK_IMAGE_LAYOUT_UNDEFINED: {
2731 if (accessMask != 0) {
2732 // TODO: Verify against Valid Use section spec
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002733 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 +02002734 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002735 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2736 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
2737 }
2738 break;
2739 }
Chris Forbesbfd831d2017-04-28 17:29:10 -07002740 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR:
Dave Houlton1150cf52017-04-27 14:38:11 -06002741 // Notes: QueuePresentKHR performs automatic visibility operations,
2742 // so the app is /NOT/ required to include VK_ACCESS_MEMORY_READ_BIT
2743 // when transitioning to this layout.
2744 //
2745 // When transitioning /from/ this layout, the application needs to
2746 // avoid only a WAR hazard -- any writes need to be ordered after
2747 // the PE's reads. There is no need for a memory dependency for this
2748 // case.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06002749 // Intentionally fall through
2750
2751 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2752 // Todo -- shouldn't be valid unless extension is enabled
2753 // Intentionally fall through
Chris Forbesbfd831d2017-04-28 17:29:10 -07002754
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002755 case VK_IMAGE_LAYOUT_GENERAL:
2756 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002757 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002758 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002759}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002760
2761// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002762// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2763// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002764bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002765 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2766 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002767 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2768 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2769 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2770 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002771 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 -06002772 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2773 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002774 }
2775 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002776 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002777}
2778
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002779bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2780 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002781 bool skip = false;
2782
2783 // Track when we're observing the first use of an attachment
2784 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2785 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2786 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002787
2788 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2789 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2790 auto attach_index = subpass.pInputAttachments[j].attachment;
2791 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2792
2793 switch (subpass.pInputAttachments[j].layout) {
2794 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2795 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2796 // These are ideal.
2797 break;
2798
2799 case VK_IMAGE_LAYOUT_GENERAL:
2800 // May not be optimal. TODO: reconsider this warning based on other constraints.
2801 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2802 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2803 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2804 break;
2805
2806 default:
2807 // No other layouts are acceptable
2808 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2809 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2810 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2811 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2812 }
2813
2814 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2815 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2816 subpass.pDepthStencilAttachment->attachment == attach_index &&
2817 subpass.pDepthStencilAttachment->layout != layout;
2818 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2819 found_layout_mismatch =
2820 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2821 }
2822 if (found_layout_mismatch) {
2823 skip |= log_msg(
2824 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002825 VALIDATION_ERROR_140006ae, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002826 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a depth/color "
2827 "attachment with a different layout. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002828 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002829 }
2830
2831 if (attach_first_use[attach_index]) {
2832 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2833 pCreateInfo->pAttachments[attach_index]);
2834
2835 bool used_as_depth =
2836 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2837 bool used_as_color = false;
2838 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2839 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2840 }
2841 if (!used_as_depth && !used_as_color &&
2842 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2843 skip |= log_msg(
2844 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002845 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002846 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002847 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002848 }
2849 }
2850 attach_first_use[attach_index] = false;
2851 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002852 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2853 auto attach_index = subpass.pColorAttachments[j].attachment;
2854 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2855
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002856 // TODO: Need a way to validate shared presentable images here, currently just allowing
2857 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2858 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002859 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002860 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002861 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002862 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2863 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002864 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002865
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002866 case VK_IMAGE_LAYOUT_GENERAL:
2867 // May not be optimal; TODO: reconsider this warning based on other constraints?
2868 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2869 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2870 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2871 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002872
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002873 default:
2874 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2875 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2876 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2877 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002878 }
2879
2880 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002881 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2882 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002883 }
2884 attach_first_use[attach_index] = false;
2885 }
2886 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2887 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002888 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2889 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2890 // These are ideal.
2891 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002892
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002893 case VK_IMAGE_LAYOUT_GENERAL:
2894 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2895 // doing a bunch of transitions.
2896 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2897 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2898 "GENERAL layout for depth attachment may not give optimal performance.");
2899 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002900
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002901 default:
2902 // No other layouts are acceptable
2903 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2904 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2905 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2906 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2907 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002908 }
2909
2910 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2911 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002912 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2913 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002914 }
2915 attach_first_use[attach_index] = false;
2916 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002917 }
2918 return skip;
2919}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002920
2921// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002922bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2923 VkDeviceSize offset, VkDeviceSize end_offset) {
2924 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2925 bool skip = false;
2926 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2927 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002928 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2929 for (auto image_handle : mem_info->bound_images) {
2930 auto img_it = mem_info->bound_ranges.find(image_handle);
2931 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002932 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002933 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002934 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002935 for (auto layout : layouts) {
2936 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002937 skip |=
2938 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
2939 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2940 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2941 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
2942 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002943 }
2944 }
2945 }
2946 }
2947 }
2948 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002949 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002950}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002951
2952// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2953// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002954static 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 -06002955 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002956 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002957
2958 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002959 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06002960 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07002961 if (strict) {
2962 correct_usage = ((actual & desired) == desired);
2963 } else {
2964 correct_usage = ((actual & desired) != 0);
2965 }
2966 if (!correct_usage) {
2967 if (msgCode == -1) {
2968 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06002969 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__,
Mark Lobodzinski33826372017-04-13 11:10:11 -06002970 MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2971 "Invalid usage flag for %s 0x%" PRIxLEAST64
2972 " used by %s. In this case, %s should have %s set during creation.",
2973 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002974 } else {
2975 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski33826372017-04-13 11:10:11 -06002976 skip = log_msg(
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06002977 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, __LINE__, msgCode, "MEM",
Mark Lobodzinski33826372017-04-13 11:10:11 -06002978 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation. %s",
2979 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002980 }
2981 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002982 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002983}
2984
2985// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2986// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07002987bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002988 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002989 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
2990 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002991}
2992
2993// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2994// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07002995bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002996 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002997 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
2998 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002999}
3000
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003001bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003002 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003003 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3004
Chris Forbese0f511c2017-06-14 12:38:01 -07003005 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003006
3007 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3008 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 -06003009 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003010 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3011 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003012 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003013 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003014
3015 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
3016 skip |=
3017 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 -07003018 VALIDATION_ERROR_01400728, "DS",
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003019 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003020 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3021 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003022 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003023
3024 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
3025 skip |=
3026 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 -07003027 VALIDATION_ERROR_0140072a, "DS",
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003028 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003029 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3030 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003031 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003032 return skip;
3033}
3034
3035void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3036 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3037 GetBufferMap(device_data)
3038 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3039}
3040
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003041bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3042 bool skip = false;
3043 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003044 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3045 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003046 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003047 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3048 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003049 skip |= ValidateBufferUsageFlags(
3050 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 -06003051 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003052 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003053 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003054}
3055
3056void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3057 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3058}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003059
3060// For the given format verify that the aspect masks make sense
3061bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3062 const char *func_name) {
3063 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3064 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003065 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003066 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003067 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 -06003068 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003069 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003070 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003071 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003072 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 -06003073 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003074 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003075 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003076 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003077 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003078 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003079 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 -06003080 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003081 "%s: Depth/stencil image formats must have "
3082 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
3083 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003084 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003085 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003086 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 -06003087 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003088 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3089 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003090 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003091 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003092 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003093 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003094 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 -06003095 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003096 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003097 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003098 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003099 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 -06003100 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003101 "%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 -06003102 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003103 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003104 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003105 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003106 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 -06003107 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003108 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003109 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003110 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003111 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 -06003112 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003113 "%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 -06003114 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003115 }
3116 }
3117 return skip;
3118}
3119
Petr Kraus8423f152017-05-26 01:20:04 +02003120bool ValidateImageSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state, const bool is_imageview_2d_array,
Petr Kraus4d718682017-05-18 03:38:41 +02003121 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003122 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3123 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003124
3125 // Validate mip levels
3126 const auto image_mip_count = image_state->createInfo.mipLevels;
3127
Mark Lobodzinski602de982017-02-09 11:01:33 -07003128 if (subresourceRange.levelCount == 0) {
Petr Kraus4d718682017-05-18 03:38:41 +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_state->image), __LINE__, VALIDATION_ERROR_0a8007fc, "IMAGE",
3131 "%s: %s.levelCount is 0. %s", cmd_name, param_name, validation_error_map[VALIDATION_ERROR_0a8007fc]);
Petr Kraus4d718682017-05-18 03:38:41 +02003132 } else if (subresourceRange.levelCount == VK_REMAINING_MIP_LEVELS) {
3133 // TODO: Not in the spec VUs. Probably missing -- KhronosGroup/Vulkan-Docs#416
3134 if (subresourceRange.baseMipLevel >= image_mip_count) {
3135 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3136 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_SUBRANGE, "IMAGE",
Dave Houlton33c2d252017-06-09 17:08:32 -06003137 "%s: %s.baseMipLevel (= %" PRIu32
3138 ") is greater or equal to the mip level count of the image (i.e. "
Petr Kraus4d718682017-05-18 03:38:41 +02003139 "greater or equal to %" PRIu32 ").",
3140 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
3141 }
3142 } else {
3143 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
3144
3145 if (necessary_mip_count > image_mip_count) {
3146 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 -06003147 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0a8007fc, "IMAGE",
3148 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3149 ") is greater than the "
Petr Kraus4d718682017-05-18 03:38:41 +02003150 "mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3151 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount, necessary_mip_count,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003152 image_mip_count, validation_error_map[VALIDATION_ERROR_0a8007fc]);
Petr Kraus4d718682017-05-18 03:38:41 +02003153 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003154 }
Petr Kraus4d718682017-05-18 03:38:41 +02003155
3156 // Validate array layers
Petr Kraus8423f152017-05-26 01:20:04 +02003157 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3158 bool is_3D_to_2D_map = is_khr_maintenance1 && image_state->createInfo.imageType == VK_IMAGE_TYPE_3D && is_imageview_2d_array;
Petr Kraus4d718682017-05-18 03:38:41 +02003159
3160 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3161 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
Petr Kraus8423f152017-05-26 01:20:04 +02003162
3163 const auto invalid_layer_code =
3164 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0a800800 : VALIDATION_ERROR_0a800802) : VALIDATION_ERROR_0a8007fe;
Petr Kraus4d718682017-05-18 03:38:41 +02003165
Mark Lobodzinski602de982017-02-09 11:01:33 -07003166 if (subresourceRange.layerCount == 0) {
Petr Kraus4d718682017-05-18 03:38:41 +02003167 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3168 HandleToUint64(image_state->image), __LINE__, invalid_layer_code, "IMAGE", "%s: %s.layerCount is 0. %s",
3169 cmd_name, param_name, validation_error_map[invalid_layer_code]);
3170 } else if (subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
3171 // TODO: Not in the spec VUs. Probably missing -- KhronosGroup/Vulkan-Docs#416
3172 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3173 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3174 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_SUBRANGE, "IMAGE",
Dave Houlton33c2d252017-06-09 17:08:32 -06003175 "%s: %s.baseArrayLayer (= %" PRIu32
3176 ") is greater or equal to the %s of the image when it was created "
Petr Kraus4d718682017-05-18 03:38:41 +02003177 "(i.e. greater or equal to %" PRIu32 ").",
3178 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
3179 }
3180 } else {
3181 const uint64_t necessary_layer_count = uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
3182
3183 if (necessary_layer_count > image_layer_count) {
3184 skip |=
3185 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3186 HandleToUint64(image_state->image), __LINE__, invalid_layer_code, "IMAGE",
Dave Houlton33c2d252017-06-09 17:08:32 -06003187 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3188 ") is greater than the "
Petr Kraus4d718682017-05-18 03:38:41 +02003189 "%s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3190 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount, necessary_layer_count,
3191 image_layer_count_var_name, image_layer_count, validation_error_map[invalid_layer_code]);
3192 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003193 }
Petr Kraus4d718682017-05-18 03:38:41 +02003194
Mark Lobodzinski602de982017-02-09 11:01:33 -07003195 return skip;
3196}
3197
3198bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3199 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3200 bool skip = false;
3201 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3202 if (image_state) {
3203 skip |= ValidateImageUsageFlags(
3204 device_data, image_state,
3205 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
3206 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
3207 false, -1, "vkCreateImageView()",
3208 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3209 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003210 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003211 // Checks imported from image layer
Petr Kraus8423f152017-05-26 01:20:04 +02003212 skip |= ValidateImageSubresourceRange(device_data, image_state, create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3213 create_info->subresourceRange, "vkCreateImageView", "pCreateInfo->subresourceRange");
Mark Lobodzinski602de982017-02-09 11:01:33 -07003214
3215 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3216 VkFormat image_format = image_state->createInfo.format;
3217 VkFormat view_format = create_info->format;
3218 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
3219
3220 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3221 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
3222 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
Dave Houlton1d2022c2017-03-29 11:43:58 -06003223 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003224 std::stringstream ss;
3225 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Petr Krausbc7f5442017-05-14 23:43:38 +02003226 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3227 << ") format " << string_VkFormat(image_format)
3228 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
Mark Lobodzinski602de982017-02-09 11:01:33 -07003229 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003230 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 -06003231 VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3232 validation_error_map[VALIDATION_ERROR_0ac007f4]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003233 }
3234 } else {
3235 // Format MUST be IDENTICAL to the format the image was created with
3236 if (image_format != view_format) {
3237 std::stringstream ss;
3238 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003239 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003240 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003241 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 -06003242 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3243 validation_error_map[VALIDATION_ERROR_0ac007f6]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003244 }
3245 }
3246
3247 // Validate correct image aspect bits for desired formats and format consistency
3248 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
3249 }
3250 return skip;
3251}
3252
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003253void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3254 auto image_view_map = GetImageViewMap(device_data);
3255 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3256
3257 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003258 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003259 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3260 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003261}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003262
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003263bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3264 BUFFER_STATE *dst_buffer_state) {
3265 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003266 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3267 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003268 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003269 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3270 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3271 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3272 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003273 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003274 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003275 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003276 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003277 return skip;
3278}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003279
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003280void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3281 BUFFER_STATE *dst_buffer_state) {
3282 // Update bindings between buffers and cmd buffer
3283 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3284 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3285
3286 std::function<bool()> function = [=]() {
3287 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3288 };
3289 cb_node->validate_functions.push_back(function);
3290 function = [=]() {
3291 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3292 return false;
3293 };
3294 cb_node->validate_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003295}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003296
3297static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3298 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3299 bool skip = false;
3300 auto buffer_state = GetBufferState(device_data, buffer);
3301 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003302 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003303 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
Petr Krausbc7f5442017-05-14 23:43:38 +02003304 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003305 } else {
3306 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003307 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 -06003308 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Krausbc7f5442017-05-14 23:43:38 +02003309 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003310 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003311 }
3312 }
3313 return skip;
3314}
3315
3316bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3317 VK_OBJECT *obj_struct) {
3318 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003319 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003320 if (GetDisables(device_data)->destroy_image_view) return false;
3321 bool skip = false;
3322 if (*image_view_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003323 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003324 }
3325 return skip;
3326}
3327
3328void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3329 VK_OBJECT obj_struct) {
3330 // Any bound cmd buffers are now invalid
3331 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3332 (*GetImageViewMap(device_data)).erase(image_view);
3333}
3334
3335bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3336 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003337 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003338 if (GetDisables(device_data)->destroy_buffer) return false;
3339 bool skip = false;
3340 if (*buffer_state) {
3341 skip |= validateIdleBuffer(device_data, buffer);
3342 }
3343 return skip;
3344}
3345
3346void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3347 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3348 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3349 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3350 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003351 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003352 }
3353 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003354 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003355 GetBufferMap(device_data)->erase(buffer_state->buffer);
3356}
3357
3358bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3359 VK_OBJECT *obj_struct) {
3360 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003361 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003362 if (GetDisables(device_data)->destroy_buffer_view) return false;
3363 bool skip = false;
3364 if (*buffer_view_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003365 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003366 }
3367 return skip;
3368}
3369
3370void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3371 VK_OBJECT obj_struct) {
3372 // Any bound cmd buffers are now invalid
3373 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3374 GetBufferViewMap(device_data)->erase(buffer_view);
3375}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003376
3377bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3378 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003379 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003380 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003381 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003382 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3383 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003384 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003385 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003386 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003387 return skip;
3388}
3389
3390void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3391 std::function<bool()> function = [=]() {
3392 SetBufferMemoryValid(device_data, buffer_state, true);
3393 return false;
3394 };
3395 cb_node->validate_functions.push_back(function);
3396 // Update bindings between buffer and cmd buffer
3397 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003398}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003399
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003400bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3401 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003402 bool skip = false;
3403
3404 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003405 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3406 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003407 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 -06003408 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003409 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
3410 "must be 0 and 1, respectively. %s",
3411 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003412 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003413 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003414 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003415
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003416 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3417 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003418 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 -06003419 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003420 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3421 "must be 0 and 1, respectively. %s",
3422 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003423 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003424 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003425 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003426
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003427 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3428 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3429 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 -06003430 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003431 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
3432 "%d. For 3D images these must be 0 and 1, respectively. %s",
3433 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003434 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003435 }
3436 }
3437
3438 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3439 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003440 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003441 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003442 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 -06003443 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003444 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3445 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003446 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003447 }
3448
3449 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003450 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003451 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 -06003452 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003453 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003454 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003455 }
3456
3457 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3458 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3459 skip |= log_msg(
3460 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003461 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003462 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3463 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003464 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003465 }
3466
3467 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3468 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3469 skip |= log_msg(
3470 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003471 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003472 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3473 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003474 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003475 }
3476
3477 // subresource aspectMask must have exactly 1 bit set
3478 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3479 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3480 if (aspect_mask_bits.count() != 1) {
3481 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 -06003482 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003483 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003484 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003485 }
3486
3487 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003488 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003489 skip |= log_msg(
3490 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003491 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003492 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3493 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003494 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003495 }
3496
3497 // Checks that apply only to compressed images
3498 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3499 // reserves a place for these compressed image checks. This block of code could move there once the image
3500 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003501 if (FormatIsCompressed(image_state->createInfo.format)) {
3502 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003503
3504 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003505 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003506 skip |= log_msg(
3507 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003508 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003509 "%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 -06003510 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003511 }
3512
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003513 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003514 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003515 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 -06003516 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003517 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
3518 "height (%d). %s.",
3519 function, i, pRegions[i].bufferImageHeight, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003520 validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003521 }
3522
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003523 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003524 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3525 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3526 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003527 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 -06003528 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003529 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3530 "width & height (%d, %d). %s.",
3531 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003532 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003533 }
3534
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003535 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003536 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3537 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003538 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 -06003539 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003540 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3541 ") must be a multiple of the compressed image's texel block "
3542 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3543 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003544 validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003545 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003546
3547 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003548 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003549 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003550 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3551 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 -06003552 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003553 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3554 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3555 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003556 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003557 }
3558
3559 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003560 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003561 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3562 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 -06003563 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003564 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3565 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3566 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003567 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003568 }
3569
3570 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003571 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003572 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3573 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 -06003574 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003575 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3576 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3577 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003578 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003579 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003580 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003581 }
3582
3583 return skip;
3584}
3585
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003586static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3587 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003588 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003589 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003590
3591 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003592 VkExtent3D extent = pRegions[i].imageExtent;
3593 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003594
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003595 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3596 {
3597 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3598 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3599 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3600 extent.height, extent.depth);
3601 }
3602
3603 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3604
3605 // 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 -06003606 if (FormatIsCompressed(image_info->format)) {
3607 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003608 if (image_extent.width % block_extent.width) {
3609 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3610 }
3611 if (image_extent.height % block_extent.height) {
3612 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3613 }
3614 if (image_extent.depth % block_extent.depth) {
3615 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3616 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003617 }
3618
Dave Houltonfc1a4052017-04-27 14:32:45 -06003619 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003620 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 -07003621 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003622 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003623 }
3624 }
3625
3626 return skip;
3627}
3628
Chris Forbese8ba09a2017-06-01 17:39:02 -07003629static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003630 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3631 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003632 bool skip = false;
3633
3634 VkDeviceSize buffer_size = buff_state->createInfo.size;
3635
3636 for (uint32_t i = 0; i < regionCount; i++) {
3637 VkExtent3D copy_extent = pRegions[i].imageExtent;
3638
3639 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3640 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003641 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003642
Dave Houltonf3229d52017-02-21 15:59:08 -07003643 // Handle special buffer packing rules for specific depth/stencil formats
3644 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003645 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003646 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3647 switch (image_state->createInfo.format) {
3648 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003649 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003650 break;
3651 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003652 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003653 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003654 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003655 case VK_FORMAT_D24_UNORM_S8_UINT:
3656 unit_size = 4;
3657 break;
3658 default:
3659 break;
3660 }
3661 }
3662
Dave Houlton1d2022c2017-03-29 11:43:58 -06003663 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003664 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003665 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003666 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3667 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3668
3669 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3670 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3671 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003672 }
3673
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003674 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3675 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3676 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003677 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003678 } else {
3679 // Calculate buffer offset of final copied byte, + 1.
3680 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3681 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3682 max_buffer_offset *= unit_size; // convert to bytes
3683 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003684
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003685 if (buffer_size < max_buffer_offset) {
3686 skip |=
3687 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3688 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
3689 i, buffer_size, validation_error_map[msg_code]);
3690 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003691 }
3692 }
3693
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003694 return skip;
3695}
3696
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003697bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003698 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003699 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003700 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3701 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3702
3703 // Validate command buffer state
3704 if (CB_RECORDING != cb_node->state) {
3705 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 -06003706 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_19202413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003707 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003708 validation_error_map[VALIDATION_ERROR_19202413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003709 } else {
3710 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
3711 }
3712
3713 // Command pool must support graphics, compute, or transfer operations
3714 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3715
3716 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3717 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3718 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 -06003719 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003720 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
3721 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003722 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003723 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003724 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003725 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07003726 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06003727 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003728
3729 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003730 VALIDATION_ERROR_19200178);
3731 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
3732 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003733
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003734 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003735 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003736 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003737 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3738 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
3739 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003740 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003741 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003742 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
3743 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
3744 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003745 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003746 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003747 }
3748 return skip;
3749}
3750
3751void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003752 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
3753 VkImageLayout src_image_layout) {
3754 // Make sure that all image slices are updated to correct layout
3755 for (uint32_t i = 0; i < region_count; ++i) {
3756 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
3757 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003758 // Update bindings between buffer/image and cmd buffer
3759 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003760 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003761
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003762 std::function<bool()> function = [=]() {
3763 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
3764 };
3765 cb_node->validate_functions.push_back(function);
3766 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003767 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003768 return false;
3769 };
3770 cb_node->validate_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003771}
3772
3773bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003774 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003775 const VkBufferImageCopy *pRegions, const char *func_name) {
3776 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3777 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
3778
3779 // Validate command buffer state
3780 if (CB_RECORDING != cb_node->state) {
3781 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 -06003782 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_18e02413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003783 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003784 validation_error_map[VALIDATION_ERROR_18e02413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003785 } else {
3786 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
3787 }
3788
3789 // Command pool must support graphics, compute, or transfer operations
3790 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3791 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3792 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3793 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 -06003794 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003795 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
3796 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003797 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003798 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003799 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003800 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07003801 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06003802 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003803 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003804 VALIDATION_ERROR_18e00166);
3805 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
3806 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
3807 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3808 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3809 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003810 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003811 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003812 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003813 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003814 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
3815 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
3816 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003817 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
3818 "vkCmdCopyBufferToImage()");
3819 }
3820 return skip;
3821}
3822
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003823void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003824 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
3825 VkImageLayout dst_image_layout) {
3826 // Make sure that all image slices are updated to correct layout
3827 for (uint32_t i = 0; i < region_count; ++i) {
3828 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
3829 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003830 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003831 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003832 std::function<bool()> function = [=]() {
3833 SetImageMemoryValid(device_data, dst_image_state, true);
3834 return false;
3835 };
3836 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003837 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003838 cb_node->validate_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003839}
Mike Weiblen672b58b2017-02-21 14:32:53 -07003840
3841bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
3842 const auto report_data = core_validation::GetReportData(device_data);
3843 bool skip = false;
3844 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
3845
3846 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
3847 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
3848 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
3849 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003850 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 -06003851 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003852 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003853 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003854 }
3855
3856 IMAGE_STATE *image_entry = GetImageState(device_data, image);
3857 if (!image_entry) {
3858 return skip;
3859 }
3860
3861 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
3862 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003863 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 -06003864 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003865 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003866 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003867 }
3868
3869 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
3870 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003871 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 -06003872 __LINE__, VALIDATION_ERROR_0a4007cc, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003873 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003874 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_0a4007cc]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003875 }
3876
3877 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
3878 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003879 skip |=
3880 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
3881 __LINE__, VALIDATION_ERROR_0a4007ce, "IMAGE",
3882 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
3883 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_0a4007ce]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003884 }
3885
3886 // VU 00741: subresource's aspect must be compatible with image's format.
3887 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003888 if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07003889 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
3890 skip |= log_msg(
Petr Krausbc7f5442017-05-14 23:43:38 +02003891 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003892 VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003893 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003894 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003895 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003896 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07003897 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003898 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 -06003899 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003900 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
3901 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003902 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003903 }
3904 }
3905 return skip;
3906}