blob: d69917bd680caf1240c10dd147933cbd47b87423 [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
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600354bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier,
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700355 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.
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600481bool ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mike Weiblen62d08a32017-03-07 22:18:27 -0700482 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700483 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700484
Mike Weiblen62d08a32017-03-07 22:18:27 -0700485 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
486 auto img_barrier = &pImageMemoryBarriers[i];
487 if (!img_barrier) continue;
488
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600489 auto image_state = GetImageState(device_data, img_barrier->image);
490 if (image_state) {
491 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
492 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
493 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
494
495 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
496 if (image_state->layout_locked) {
497 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600498 skip |= log_msg(
499 core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600500 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, 0, "DS",
501 "Attempting to transition shared presentable image 0x%" PRIxLEAST64
502 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
503 reinterpret_cast<const uint64_t &>(img_barrier->image), string_VkImageLayout(img_barrier->oldLayout),
504 string_VkImageLayout(img_barrier->newLayout));
505 }
506 }
507
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600508 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600509 // For a Depth/Stencil image both aspects MUST be set
510 if (FormatIsDepthAndStencil(image_create_info->format)) {
511 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
512 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
513 if ((aspect_mask & ds_mask) != (ds_mask)) {
514 skip |=
515 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200516 VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(img_barrier->image), __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600517 VALIDATION_ERROR_0a00096e, "DS",
518 "%s: Image barrier 0x%p references image 0x%" PRIx64
519 " of format %s that must have the depth and stencil aspects set, but its "
520 "aspectMask is 0x%" PRIx32 ". %s",
Petr Krausbc7f5442017-05-14 23:43:38 +0200521 func_name, img_barrier, HandleToUint64(img_barrier->image), string_VkFormat(image_create_info->format),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600522 aspect_mask, validation_error_map[VALIDATION_ERROR_0a00096e]);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600523 }
524 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600525 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
526 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700527
Mike Weiblen62d08a32017-03-07 22:18:27 -0700528 for (uint32_t j = 0; j < level_count; j++) {
529 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
530 for (uint32_t k = 0; k < layer_count; k++) {
531 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600532 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
533 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
534 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
535 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700536 }
537 }
538 }
539 return skip;
540}
541
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700542void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
543 const VkImageMemoryBarrier *pImgMemBarriers) {
544 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700545
546 for (uint32_t i = 0; i < memBarrierCount; ++i) {
547 auto mem_barrier = &pImgMemBarriers[i];
548 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700549
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600550 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
551 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
552 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
553
554 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700555 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600556 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700557 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
558 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
559 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
560 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
561 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
562 }
563 }
564 }
565}
566
Tobin Ehlisc8266452017-04-07 12:20:30 -0600567bool VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600568 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600569 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code, bool *error) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700570 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600571 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600572 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700573
574 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
575 uint32_t layer = i + subLayers.baseArrayLayer;
576 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
577 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600578 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
579 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600580 *error = true;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600581 // TODO: Improve log message in the next pass
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600582 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 +0200583 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600584 "%s: Cannot use image 0x%" PRIxLEAST64
585 " with specific layout %s that doesn't match the actual current layout %s.",
Petr Krausbc7f5442017-05-14 23:43:38 +0200586 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout),
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600587 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600588 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700589 }
590 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600591 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
592 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
593 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700594 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
595 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600596 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +0200597 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer), __LINE__,
598 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600599 "%s: For optimal performance image 0x%" PRIxLEAST64 " layout should be %s instead of GENERAL.",
Petr Krausbc7f5442017-05-14 23:43:38 +0200600 caller, HandleToUint64(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700601 }
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600602 } else if (GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600603 if (image_state->shared_presentable) {
604 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
605 // TODO: Add unique error id when available.
606 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
607 __LINE__, msg_code, "DS",
608 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
609 string_VkImageLayout(optimal_layout));
610 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600611 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700612 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -0600613 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600614 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 +0200615 HandleToUint64(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600616 "%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 +0200617 caller, HandleToUint64(image), string_VkImageLayout(explicit_layout),
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600618 string_VkImageLayout(optimal_layout), validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700619 }
620 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600621 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700622}
623
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700624void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
625 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700626 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700627 if (!renderPass) return;
628
629 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
630 if (framebuffer_state) {
631 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
632 auto image_view = framebuffer_state->createInfo.pAttachments[i];
633 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
634 }
635 }
636}
637
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700638bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700639 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600640 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700641 const debug_report_data *report_data = core_validation::GetReportData(device_data);
642
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600643 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600644 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 -0600645 VALIDATION_ERROR_09e0075e, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
646 validation_error_map[VALIDATION_ERROR_09e0075e]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600647
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600648 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600649 }
650
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600651 VkFormatProperties properties = GetFormatProperties(device_data, pCreateInfo->format);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600652
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600653 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties.linearTilingFeatures == 0)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600654 std::stringstream ss;
655 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600656 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 -0600657 VALIDATION_ERROR_09e007a2, "IMAGE", "%s. %s", ss.str().c_str(),
658 validation_error_map[VALIDATION_ERROR_09e007a2]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600659
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600660 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600661 }
662
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600663 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties.optimalTilingFeatures == 0)) {
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600664 std::stringstream ss;
665 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600666 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 -0600667 VALIDATION_ERROR_09e007ac, "IMAGE", "%s. %s", ss.str().c_str(),
668 validation_error_map[VALIDATION_ERROR_09e007ac]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600669
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600670 return skip;
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600671 }
672
Lenny Komowb79f04a2017-09-18 17:07:00 -0600673 // TODO: Add checks for EXTENDED_USAGE images to validate images are compatible
674 // For EXTENDED_USAGE images, format can match any image COMPATIBLE with original image
675 if (!GetDeviceExtensions(device_data)->vk_khr_maintenance2 || !(pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR)) {
676 // Validate that format supports usage as color attachment
677 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
678 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
679 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
680 std::stringstream ss;
681 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
682 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
683 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
684 VALIDATION_ERROR_09e007b2, "IMAGE", "%s. %s", ss.str().c_str(),
685 validation_error_map[VALIDATION_ERROR_09e007b2]);
686 }
687 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
688 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
689 std::stringstream ss;
690 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
691 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
692 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
693 VALIDATION_ERROR_09e007a8, "IMAGE", "%s. %s", ss.str().c_str(),
694 validation_error_map[VALIDATION_ERROR_09e007a8]);
695 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600696 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600697
Lenny Komowb79f04a2017-09-18 17:07:00 -0600698 // Validate that format supports usage as depth/stencil attachment
699 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
700 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
701 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
702 std::stringstream ss;
703 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
704 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
705 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
706 VALIDATION_ERROR_09e007b4, "IMAGE", "%s. %s", ss.str().c_str(),
707 validation_error_map[VALIDATION_ERROR_09e007b4]);
708 }
709 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
710 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
711 std::stringstream ss;
712 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
713 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
714 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
715 VALIDATION_ERROR_09e007aa, "IMAGE", "%s. %s", ss.str().c_str(),
716 validation_error_map[VALIDATION_ERROR_09e007aa]);
717 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600718 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700719 }
720
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600721 VkImageFormatProperties ImageFormatProperties = GetImageFormatProperties(
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700722 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700723
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700724 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700725 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
Tobin Ehlisa55b1d42017-04-04 12:23:48 -0600726 // TODO : This is also covering 2918 & 2919. Break out into separate checks
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700727 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600728 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 -0600729 VALIDATION_ERROR_09e007b8, "Image",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600730 "CreateImage extent is 0 for at least one required dimension for image: "
731 "Width = %d Height = %d Depth = %d. %s",
732 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600733 validation_error_map[VALIDATION_ERROR_09e007b8]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700734 }
735
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600736 // TODO: VALIDATION_ERROR_09e00770 VALIDATION_ERROR_09e00772 VALIDATION_ERROR_09e00776 VALIDATION_ERROR_09e0076e
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700737 // All these extent-related VUs should be checked here
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600738 if ((pCreateInfo->extent.depth > ImageFormatProperties.maxExtent.depth) ||
739 (pCreateInfo->extent.width > ImageFormatProperties.maxExtent.width) ||
740 (pCreateInfo->extent.height > ImageFormatProperties.maxExtent.height)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
742 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
743 "CreateImage extents exceed allowable limits for format: "
744 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
745 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600746 ImageFormatProperties.maxExtent.width, ImageFormatProperties.maxExtent.height,
747 ImageFormatProperties.maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700748 }
749
Dave Houlton1150cf52017-04-27 14:38:11 -0600750 uint64_t totalSize =
751 ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height * (uint64_t)pCreateInfo->extent.depth *
752 (uint64_t)pCreateInfo->arrayLayers * (uint64_t)pCreateInfo->samples * (uint64_t)FormatSize(pCreateInfo->format) +
753 (uint64_t)imageGranularity) &
754 ~(uint64_t)imageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700755
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600756 if (totalSize > ImageFormatProperties.maxResourceSize) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600757 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
758 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
759 "CreateImage resource size exceeds allowable maximum "
760 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600761 totalSize, ImageFormatProperties.maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700762 }
763
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600764 // TODO: VALIDATION_ERROR_09e0077e
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600765 if (pCreateInfo->mipLevels > ImageFormatProperties.maxMipLevels) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600766 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
767 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
768 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600769 ImageFormatProperties.maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700770 }
771
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600772 if (pCreateInfo->arrayLayers > ImageFormatProperties.maxArrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600773 skip |=
774 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
775 VALIDATION_ERROR_09e00780, "Image",
776 "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600777 ImageFormatProperties.maxArrayLayers, validation_error_map[VALIDATION_ERROR_09e00780]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700778 }
779
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600780 if ((pCreateInfo->samples & ImageFormatProperties.sampleCounts) == 0) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600781 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 -0600782 VALIDATION_ERROR_09e0078e, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Jeremy Kniager7ec550f2017-08-16 14:57:42 -0600783 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties.sampleCounts,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600784 validation_error_map[VALIDATION_ERROR_09e0078e]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700785 }
786
787 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600788 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 -0600789 VALIDATION_ERROR_09e0b801, "Image",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600790 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
791 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600792 validation_error_map[VALIDATION_ERROR_09e0b801]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700793 }
794
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600795 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600796 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 -0600797 VALIDATION_ERROR_09e00792, "DS",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600798 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
799 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600800 validation_error_map[VALIDATION_ERROR_09e00792]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600801 }
802
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600803 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600804 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
805 DRAWSTATE_INVALID_FEATURE, "DS",
806 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
807 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600808 }
809
Lenny Komowb79f04a2017-09-18 17:07:00 -0600810 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
811 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
812 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
813 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
814 // TODO: Add Maintenance2 VUID
815 skip |=
816 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
817 VALIDATION_ERROR_UNDEFINED, "DS",
818 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
819 "format must be block, ETC or ASTC compressed, but is %s",
820 string_VkFormat(pCreateInfo->format));
821 }
822 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
823 // TODO: Add Maintenance2 VUID
824 skip |=
825 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
826 VALIDATION_ERROR_UNDEFINED, "DS",
827 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
828 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
829 }
830 }
831 }
832
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600833 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700834}
835
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700836void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700837 IMAGE_LAYOUT_NODE image_state;
838 image_state.layout = pCreateInfo->initialLayout;
839 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700840 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 -0700841 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700842 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
843 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700844}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700845
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700846bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700847 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700848 *image_state = core_validation::GetImageState(device_data, image);
Petr Krausbc7f5442017-05-14 23:43:38 +0200849 *obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700850 if (disabled->destroy_image) return false;
851 bool skip = false;
852 if (*image_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -0600853 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, "vkDestroyImage",
854 VALIDATION_ERROR_252007d0);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700855 }
856 return skip;
857}
858
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700859void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700860 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
861 // Clean up memory mapping, bindings and range references for image
862 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700863 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700864 if (mem_info) {
865 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
866 }
867 }
Mark Lobodzinski33826372017-04-13 11:10:11 -0600868 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700869 // Remove image from imageMap
870 core_validation::GetImageMap(device_data)->erase(image);
871 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
872 core_validation::GetImageSubresourceMap(device_data);
873
874 const auto &sub_entry = imageSubresourceMap->find(image);
875 if (sub_entry != imageSubresourceMap->end()) {
876 for (const auto &pair : sub_entry->second) {
877 core_validation::GetImageLayoutMap(device_data)->erase(pair);
878 }
879 imageSubresourceMap->erase(sub_entry);
880 }
881}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700882
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700883bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700884 bool skip = false;
885 const debug_report_data *report_data = core_validation::GetReportData(device_data);
886
887 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
888 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
889 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 +0200890 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700891 }
892
Dave Houlton1d2022c2017-03-29 11:43:58 -0600893 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700894 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
895 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 -0600896 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
897 validation_error_map[VALIDATION_ERROR_1880000e]);
Dave Houlton1d2022c2017-03-29 11:43:58 -0600898 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700899 char const str[] = "vkCmdClearColorImage called with compressed image.";
900 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 -0600901 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_1880000e, "IMAGE", "%s. %s", str,
902 validation_error_map[VALIDATION_ERROR_1880000e]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700903 }
904
905 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
906 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
907 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 -0600908 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_18800004, "IMAGE", "%s. %s", str,
909 validation_error_map[VALIDATION_ERROR_18800004]);
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700910 }
911 return skip;
912}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700913
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600914uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
915 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
916 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700917 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600918 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700919 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600920 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700921}
922
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600923uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
924 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
925 uint32_t array_layer_count = range->layerCount;
926 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
927 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700928 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600929 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700930}
931
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700932bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700933 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
934 bool skip = false;
935 const debug_report_data *report_data = core_validation::GetReportData(device_data);
936
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600937 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
938 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700939
940 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
941 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700942 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
943 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600944 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 +0200945 HandleToUint64(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700946 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
947 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600948 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski28426ae2017-06-01 07:56:38 -0600949 if (!GetDeviceExtensions(device_data)->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600950 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600951 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 -0600952 HandleToUint64(image_state->image), __LINE__, 0, "DS",
953 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
954 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600955
956 } else {
957 if (image_state->shared_presentable) {
958 skip |= log_msg(
959 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlisfb0661c2017-05-11 08:52:51 -0600960 HandleToUint64(image_state->image), __LINE__, 0, "DS",
Mark Lobodzinski087380c2017-05-16 14:42:25 -0600961 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
962 string_VkImageLayout(dest_image_layout));
963 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600964 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700965 } else {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600966 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_1880000a;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700967 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600968 error_code = VALIDATION_ERROR_18a00018;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700969 } else {
970 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
971 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600972 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 +0200973 HandleToUint64(image_state->image), __LINE__, error_code, "DS",
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600974 "%s: Layout for cleared image is %s but can only be "
975 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
976 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700977 }
978 }
979
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600980 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
981 uint32_t level = level_index + range.baseMipLevel;
982 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
983 uint32_t layer = layer_index + range.baseArrayLayer;
984 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700985 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700986 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700987 if (node.layout != dest_image_layout) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600988 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_18800008;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700989 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -0600990 error_code = VALIDATION_ERROR_18a00016;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700991 } else {
992 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
993 }
994 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
995 __LINE__, error_code, "DS",
996 "%s: Cannot clear an image whose layout is %s and "
997 "doesn't match the current layout %s. %s",
998 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
999 validation_error_map[error_code]);
1000 }
1001 }
1002 }
1003 }
1004
1005 return skip;
1006}
1007
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001008void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
1009 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001010 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
1011 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1012 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001013
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001014 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1015 uint32_t level = level_index + range.baseMipLevel;
1016 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1017 uint32_t layer = layer_index + range.baseArrayLayer;
1018 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001019 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001020 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1021 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 -07001022 }
1023 }
1024 }
1025}
1026
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001027bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001028 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
1029 bool skip = false;
1030 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001031 auto cb_node = GetCBNode(dev_data, commandBuffer);
1032 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001033 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001034 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_18800006);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001035 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001036 VALIDATION_ERROR_18802415);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001037 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001038 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_18800017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001039 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001040 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001041 skip |= ValidateCmdClearColorSubresourceRange(dev_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001042 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001043 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001044 }
1045 }
1046 return skip;
1047}
1048
1049// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001050void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
Chris Forbes38c2e792017-06-16 16:42:35 -07001051 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001052 auto cb_node = GetCBNode(dev_data, commandBuffer);
1053 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001054 if (cb_node && image_state) {
1055 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
1056 std::function<bool()> function = [=]() {
1057 SetImageMemoryValid(dev_data, image_state, true);
1058 return false;
1059 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06001060 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001061 for (uint32_t i = 0; i < rangeCount; ++i) {
1062 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
1063 }
1064 }
1065}
1066
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001067bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
1068 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001069 const VkImageSubresourceRange *pRanges) {
1070 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001071 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1072
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001073 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001074 auto cb_node = GetCBNode(device_data, commandBuffer);
1075 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001076 if (cb_node && image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001077 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00014);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001078 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001079 VALIDATION_ERROR_18a02415);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001080 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001081 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_18a00017);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001082 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001083 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001084 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001085 skip |=
1086 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001087 // Image aspect must be depth or stencil or both
1088 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1089 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1090 char const str[] =
1091 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
1092 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
1093 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 +02001094 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001095 }
1096 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001097 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001098 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1100 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a0001c, "IMAGE", "%s. %s", str,
1101 validation_error_map[VALIDATION_ERROR_18a0001c]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001102 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001103 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1104 char const str[] =
1105 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1106 "set.";
1107 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1108 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00012, "IMAGE", "%s. %s", str,
1109 validation_error_map[VALIDATION_ERROR_18a00012]);
1110 }
1111 VkFormatProperties props = GetFormatProperties(device_data, image_state->createInfo.format);
1112 VkImageTiling tiling = image_state->createInfo.tiling;
1113 VkFormatFeatureFlags flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
1114 if ((GetDeviceExtensions(device_data)->vk_khr_maintenance1) &&
1115 (VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR != (flags & VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR))) {
1116 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1117 HandleToUint64(image), __LINE__, VALIDATION_ERROR_18a00010, "IMAGE",
1118 "vkCmdClearDepthStencilImage() called with an image of format %s and tiling %s that does not support "
1119 "VK_FORMAT_FEATURE_TRANSFER_DST_BIT_KHR. %s",
1120 string_VkFormat(image_state->createInfo.format), string_VkImageTiling(image_state->createInfo.tiling),
1121 validation_error_map[VALIDATION_ERROR_18a00010]);
1122 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001123 }
1124 return skip;
1125}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001126
1127// Returns true if [x, xoffset] and [y, yoffset] overlap
1128static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1129 bool result = false;
1130 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1131 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1132
1133 if (intersection_max > intersection_min) {
1134 result = true;
1135 }
1136 return result;
1137}
1138
1139// Returns true if two VkImageCopy structures overlap
1140static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1141 bool result = false;
1142 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1143 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1144 dst->dstSubresource.layerCount))) {
1145 result = true;
1146 switch (type) {
1147 case VK_IMAGE_TYPE_3D:
1148 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1149 // Intentionally fall through to 2D case
1150 case VK_IMAGE_TYPE_2D:
1151 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1152 // Intentionally fall through to 1D case
1153 case VK_IMAGE_TYPE_1D:
1154 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1155 break;
1156 default:
1157 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1158 assert(false);
1159 }
1160 }
1161 return result;
1162}
1163
Dave Houltonfc1a4052017-04-27 14:32:45 -06001164// Returns non-zero if offset and extent exceed image extents
1165static const uint32_t x_bit = 1;
1166static const uint32_t y_bit = 2;
1167static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001168static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001169 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001170 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001171 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1172 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001173 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001174 }
1175 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1176 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001177 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001178 }
1179 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1180 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001181 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001182 }
1183 return result;
1184}
1185
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001186// Test if two VkExtent3D structs are equivalent
1187static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1188 bool result = true;
1189 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1190 (extent->depth != other_extent->depth)) {
1191 result = false;
1192 }
1193 return result;
1194}
1195
Dave Houlton6f9059e2017-05-02 17:15:13 -06001196// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001197static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1198 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001199
1200 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001201 if (mip >= img->createInfo.mipLevels) {
1202 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001203 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001204
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001205 // 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 -06001206 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001207 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1208 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1209 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001210
Dave Houlton6f9059e2017-05-02 17:15:13 -06001211 // Image arrays have an effective z extent that isn't diminished by mip level
1212 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001213 extent.depth = img->createInfo.arrayLayers;
1214 }
1215
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001216 return extent;
1217}
1218
1219// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001220static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001221 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1222}
1223
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001224// Test if the extent argument has any dimensions set to 0.
1225static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1226 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1227}
1228
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001229// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1230static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1231 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1232 VkExtent3D granularity = {0, 0, 0};
1233 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1234 if (pPool) {
1235 granularity =
1236 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001237 if (FormatIsCompressed(img->createInfo.format)) {
1238 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001239 granularity.width *= block_size.width;
1240 granularity.height *= block_size.height;
1241 }
1242 }
1243 return granularity;
1244}
1245
1246// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1247static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1248 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001249 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1250 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001251 valid = false;
1252 }
1253 return valid;
1254}
1255
1256// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1257static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1258 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1259 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1260 bool skip = false;
1261 VkExtent3D offset_extent = {};
1262 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1263 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1264 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001265 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001266 // 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 -07001267 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001268 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1269 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1270 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1271 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1272 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001273 }
1274 } else {
1275 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1276 // integer multiples of the image transfer granularity.
1277 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001278 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1279 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1280 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1281 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1282 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1283 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001284 }
1285 }
1286 return skip;
1287}
1288
1289// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1290static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1291 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001292 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001293 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1294 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001295 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001296 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1297 // subresource extent.
1298 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001299 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1300 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1301 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1302 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1303 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1304 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001305 }
1306 } else {
1307 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1308 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1309 // subresource extent dimensions.
1310 VkExtent3D offset_extent_sum = {};
1311 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1312 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1313 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001314 bool x_ok = true;
1315 bool y_ok = true;
1316 bool z_ok = true;
1317 switch (image_type) {
1318 case VK_IMAGE_TYPE_3D:
1319 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1320 (subresource_extent->depth == offset_extent_sum.depth));
1321 // Intentionally fall through to 2D case
1322 case VK_IMAGE_TYPE_2D:
1323 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1324 (subresource_extent->height == offset_extent_sum.height));
1325 // Intentionally fall through to 1D case
1326 case VK_IMAGE_TYPE_1D:
1327 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1328 (subresource_extent->width == offset_extent_sum.width));
1329 break;
1330 default:
1331 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1332 assert(false);
1333 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001334 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001335 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001336 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 +02001337 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001338 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1339 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1340 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1341 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1342 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1343 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1344 }
1345 }
1346 return skip;
1347}
1348
1349// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1350static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1351 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1352 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1353
1354 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001355 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001356 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 +02001357 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001358 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1359 "transfer granularity width (%d).",
1360 function, i, member, value, granularity);
1361 }
1362 return skip;
1363}
1364
1365// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1366static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1367 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1368 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1369 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001370 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001371 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 +02001372 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001373 "%s: pRegion[%d].%s (%" PRIdLEAST64
1374 ") must be an even integer multiple of this command buffer's queue family image transfer "
1375 "granularity width (%d).",
1376 function, i, member, value, granularity);
1377 }
1378 return skip;
1379}
1380
1381// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1382bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1383 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1384 const uint32_t i, const char *function) {
1385 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001386 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001387 // TODO: Add granularity checking for compressed formats
1388
1389 // bufferRowLength must be a multiple of the compressed texel block width
1390 // bufferImageHeight must be a multiple of the compressed texel block height
1391 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1392 // bufferOffset must be a multiple of the compressed texel block size in bytes
1393 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1394 // must equal the image subresource width
1395 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1396 // must equal the image subresource height
1397 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1398 // must equal the image subresource depth
1399 } else {
1400 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1401 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1402 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1403 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1404 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1405 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1406 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001407 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001408 }
1409 return skip;
1410}
1411
1412// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1413bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001414 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1415 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001416 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001417 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001418 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001419 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001420 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001421 VkExtent3D extent = region->extent;
1422 if (FormatIsCompressed(src_img->createInfo.format) && !FormatIsCompressed(dst_img->createInfo.format)) {
1423 // Src is compressed and dest is uncompressed, adjust extent:
1424 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_img->createInfo.format);
1425 extent.width /= block_size.width;
1426 extent.height /= block_size.height;
1427 }
1428 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001429 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001430
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001431 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001432 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001433 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001434 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001435 if (!FormatIsCompressed(src_img->createInfo.format) && FormatIsCompressed(dst_img->createInfo.format)) {
1436 // Src is uncompressed and dest is compressed, adjust extent:
1437 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_img->createInfo.format);
1438 extent.width *= block_size.width;
1439 extent.height *= block_size.height;
1440 }
1441 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001442 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001443 return skip;
1444}
1445
Dave Houlton6f9059e2017-05-02 17:15:13 -06001446// Validate contents of a VkImageCopy struct
1447bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1448 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1449 bool skip = false;
1450
1451 for (uint32_t i = 0; i < regionCount; i++) {
1452 VkImageCopy image_copy = ic_regions[i];
1453 bool slice_override = false;
1454 uint32_t depth_slices = 0;
1455
1456 // Special case for copying between a 1D/2D array and a 3D image
1457 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1458 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
1459 depth_slices = image_copy.dstSubresource.layerCount; // Slice count from 2D subresource
1460 slice_override = (depth_slices != 1);
1461 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
1462 depth_slices = image_copy.srcSubresource.layerCount; // Slice count from 2D subresource
1463 slice_override = (depth_slices != 1);
1464 }
1465
1466 // Do all checks on source image
1467 //
1468 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
1469 if ((0 != image_copy.srcOffset.y) || (1 != image_copy.extent.height)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001470 skip |=
1471 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1472 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1473 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1474 "be 0 and 1, respectively. %s",
1475 i, image_copy.srcOffset.y, image_copy.extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001476 }
1477 }
1478
1479 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (src_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
1480 if ((0 != image_copy.srcOffset.z) || (1 != image_copy.extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001481 skip |=
1482 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1483 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00128, "IMAGE",
1484 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1485 "these must be 0 and 1, respectively. %s",
1486 i, image_copy.srcOffset.z, image_copy.extent.depth, validation_error_map[VALIDATION_ERROR_09c00128]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001487 }
1488 }
1489
1490 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001491 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001492 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1493 if ((0 != image_copy.srcSubresource.baseArrayLayer) || (1 != image_copy.srcSubresource.layerCount)) {
1494 skip |=
1495 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001496 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001497 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1498 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1499 i, image_copy.srcSubresource.baseArrayLayer, image_copy.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001500 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001501 }
1502 }
1503 } else { // Pre maint 1
1504 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1505 if ((0 != image_copy.srcSubresource.baseArrayLayer) || (1 != image_copy.srcSubresource.layerCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001506 skip |=
1507 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1508 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1509 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1510 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1511 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
1512 i, image_copy.srcSubresource.baseArrayLayer, image_copy.srcSubresource.layerCount,
1513 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001514 }
1515 }
1516 }
1517
1518 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
1519 if ((image_copy.srcSubresource.baseArrayLayer >= src_state->createInfo.arrayLayers) ||
1520 (image_copy.srcSubresource.baseArrayLayer + image_copy.srcSubresource.layerCount > src_state->createInfo.arrayLayers)) {
1521 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 -06001522 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0012a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001523 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer (%d) must be less than the source image's "
1524 "arrayLayers (%d), and the sum of baseArrayLayer and srcSubresource.layerCount (%d) must be less than "
1525 "or equal to the source image's arrayLayers. %s",
1526 i, image_copy.srcSubresource.baseArrayLayer, src_state->createInfo.arrayLayers,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001527 image_copy.srcSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c0012a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001528 }
1529
1530 // Checks that apply only to compressed images
1531 if (FormatIsCompressed(src_state->createInfo.format)) {
1532 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
1533
1534 // image offsets must be multiples of block dimensions
1535 if ((SafeModulo(image_copy.srcOffset.x, block_size.width) != 0) ||
1536 (SafeModulo(image_copy.srcOffset.y, block_size.height) != 0) ||
1537 (SafeModulo(image_copy.srcOffset.z, block_size.depth) != 0)) {
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 &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001540 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1541 "texel width & height (%d, %d). %s.",
1542 i, image_copy.srcOffset.x, image_copy.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001543 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001544 }
1545
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001546 // Extent width must be a multiple of block width, or extent+offset width must equal subresource width
1547 VkExtent3D adj_extent = image_copy.extent;
1548 if (!FormatIsCompressed(dst_state->createInfo.format)) {
1549 // Copying from compressed source. Modify extent to be extent / texel block size
1550 adj_extent.width /= block_size.width;
1551 adj_extent.height /= block_size.height;
1552 }
1553
Dave Houlton6f9059e2017-05-02 17:15:13 -06001554 VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(image_copy.srcSubresource));
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001555 if ((SafeModulo(adj_extent.width, block_size.width) != 0) &&
1556 (adj_extent.width + image_copy.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001557 skip |=
1558 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001559 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001560 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1561 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001562 i, adj_extent.width, block_size.width, image_copy.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001563 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001564 }
1565
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001566 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
1567 if ((SafeModulo(adj_extent.height, block_size.height) != 0) &&
1568 (adj_extent.height + image_copy.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001569 skip |=
1570 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001571 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001572 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1573 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001574 i, adj_extent.height, block_size.height, image_copy.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001575 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001576 }
1577
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001578 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton6f9059e2017-05-02 17:15:13 -06001579 uint32_t copy_depth = (slice_override ? depth_slices : image_copy.extent.depth);
1580 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + image_copy.srcOffset.z != mip_extent.depth)) {
1581 skip |=
1582 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001583 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001584 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1585 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
1586 i, image_copy.extent.depth, block_size.depth, image_copy.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001587 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001588 }
1589 } // Compressed
1590
1591 // Do all checks on dest image
1592 //
1593 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
1594 if ((0 != image_copy.dstOffset.y) || (1 != image_copy.extent.height)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001595 skip |=
1596 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1597 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1598 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and extent.height is %d. For 1D images these must "
1599 "be 0 and 1, respectively. %s",
1600 i, image_copy.dstOffset.y, image_copy.extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001601 }
1602 }
1603
1604 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
1605 if ((0 != image_copy.dstOffset.z) || (1 != image_copy.extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001606 skip |=
1607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1608 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00134, "IMAGE",
1609 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1610 "these must be 0 and 1, respectively. %s",
1611 i, image_copy.dstOffset.z, image_copy.extent.depth, validation_error_map[VALIDATION_ERROR_09c00134]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001612 }
1613 }
1614
1615 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1616 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
1617 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 -06001618 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001619 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1620 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1621 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001622 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001623 }
1624 }
1625 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001626 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001627 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1628 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
1629 skip |=
1630 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001631 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001632 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1633 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1634 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001635 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001636 }
1637 }
1638 } else { // Pre maint 1
1639 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1640 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001641 skip |=
1642 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1643 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1644 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1645 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1646 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
1647 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
1648 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001649 }
1650 }
1651 }
1652
1653 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
1654 if ((image_copy.dstSubresource.baseArrayLayer >= dst_state->createInfo.arrayLayers) ||
1655 (image_copy.dstSubresource.baseArrayLayer + image_copy.dstSubresource.layerCount > dst_state->createInfo.arrayLayers)) {
1656 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 -06001657 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00136, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001658 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer (%d) must be less than the dest image's "
1659 "arrayLayers (%d), and the sum of baseArrayLayer and dstSubresource.layerCount (%d) must be less than "
1660 "or equal to the dest image's arrayLayers. %s",
1661 i, image_copy.dstSubresource.baseArrayLayer, dst_state->createInfo.arrayLayers,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001662 image_copy.dstSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c00136]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001663 }
1664
1665 // Checks that apply only to compressed images
1666 if (FormatIsCompressed(dst_state->createInfo.format)) {
1667 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
1668
1669 // image offsets must be multiples of block dimensions
1670 if ((SafeModulo(image_copy.dstOffset.x, block_size.width) != 0) ||
1671 (SafeModulo(image_copy.dstOffset.y, block_size.height) != 0) ||
1672 (SafeModulo(image_copy.dstOffset.z, block_size.depth) != 0)) {
1673 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 -06001674 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001675 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1676 "texel width & height (%d, %d). %s.",
1677 i, image_copy.dstOffset.x, image_copy.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001678 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001679 }
1680
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001681 // Extent width must be a multiple of block width, or extent+offset width must equal subresource width
1682 VkExtent3D adj_extent = image_copy.extent;
1683 if (!FormatIsCompressed(src_state->createInfo.format)) {
1684 // Copying from uncompressed source. Modify extent to be extent * texel block size
1685 adj_extent.width *= block_size.width;
1686 adj_extent.height *= block_size.height;
1687 }
1688
Dave Houlton6f9059e2017-05-02 17:15:13 -06001689 VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(image_copy.dstSubresource));
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001690 if ((SafeModulo(adj_extent.width, block_size.width) != 0) &&
1691 (adj_extent.width + image_copy.dstOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001692 skip |=
1693 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001694 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00146, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001695 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1696 "width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001697 i, adj_extent.width, block_size.width, image_copy.dstOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001698 validation_error_map[VALIDATION_ERROR_09c00146]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001699 }
1700
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001701 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
1702 if ((SafeModulo(adj_extent.height, block_size.height) != 0) &&
1703 (adj_extent.height + image_copy.dstOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001704 skip |=
1705 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001706 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001707 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1708 "height (%d), or when added to dstOffset.y (%d) must equal the image subresource height (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001709 i, adj_extent.height, block_size.height, image_copy.dstOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001710 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001711 }
1712
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001713 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton6f9059e2017-05-02 17:15:13 -06001714 uint32_t copy_depth = (slice_override ? depth_slices : image_copy.extent.depth);
1715 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + image_copy.dstOffset.z != mip_extent.depth)) {
1716 skip |=
1717 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001718 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001719 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1720 "depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1721 i, image_copy.extent.depth, block_size.depth, image_copy.dstOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001722 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001723 }
1724 } // Compressed
1725 }
1726 return skip;
1727}
1728
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001729bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001730 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1731 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001732 bool skip = false;
1733 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001734 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1735
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001736 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1737
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001738 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001739 bool slice_override = false;
1740 uint32_t depth_slices = 0;
1741
1742 // Special case for copying between a 1D/2D array and a 3D image
1743 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1744 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1745 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
1746 depth_slices = regions[i].dstSubresource.layerCount; // Slice count from 2D subresource
1747 slice_override = (depth_slices != 1);
1748 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1749 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
1750 depth_slices = regions[i].srcSubresource.layerCount; // Slice count from 2D subresource
1751 slice_override = (depth_slices != 1);
1752 }
1753
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001754 if (regions[i].srcSubresource.layerCount == 0) {
1755 std::stringstream ss;
1756 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001757 skip |=
1758 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1759 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001760 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001761
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001762 if (regions[i].dstSubresource.layerCount == 0) {
1763 std::stringstream ss;
1764 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001765 skip |=
1766 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1767 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001768 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001769
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001770 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001771 // No chance of mismatch if we're overriding depth slice count
1772 if (!slice_override) {
1773 // The number of depth slices in srcSubresource and dstSubresource must match
1774 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1775 uint32_t src_slices =
1776 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? regions[i].extent.depth
1777 : regions[i].srcSubresource.layerCount);
1778 uint32_t dst_slices =
1779 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? regions[i].extent.depth
1780 : regions[i].dstSubresource.layerCount);
1781 if (src_slices != dst_slices) {
1782 std::stringstream ss;
1783 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1784 << "] do not match";
1785 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 -06001786 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE",
1787 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001788 }
1789 }
1790 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001791 // For each region the layerCount member of srcSubresource and dstSubresource must match
1792 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1793 std::stringstream ss;
1794 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1795 << "] do not match";
1796 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 -06001797 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1798 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001799 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001800 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001801
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001802 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1803 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1804 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1805 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 -06001806 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1807 validation_error_map[VALIDATION_ERROR_09c00112]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001808 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001809
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001810 // For each region, the aspectMask member of srcSubresource must be present in the source image
1811 if (!VerifyAspectsPresent(regions[i].srcSubresource.aspectMask, src_image_state->createInfo.format)) {
1812 std::stringstream ss;
1813 ss << "vkCmdCopyImage: pRegion[" << i
1814 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1815 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 -06001816 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1817 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001818 }
1819
1820 // For each region, the aspectMask member of dstSubresource must be present in the destination image
1821 if (!VerifyAspectsPresent(regions[i].dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
1822 std::stringstream ss;
1823 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1824 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 -06001825 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1826 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001827 }
1828
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001829 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1830 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1831 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1832 std::stringstream ss;
1833 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1834 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 -06001835 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1836 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001837 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001838
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001839 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1840 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1841 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1842 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1843 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1844 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 -06001845 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a60014e, "IMAGE", "%s. %s", str,
1846 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001847 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001848
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001849 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1850 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1851 std::stringstream ss;
1852 ss << "vkCmdCopyImage: pRegions[" << i
1853 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1854 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 -06001855 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1856 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001857 }
1858 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1859 std::stringstream ss;
1860 ss << "vkCmdCopyImage: pRegions[" << i
1861 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1862 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 -06001863 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1864 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001865 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001866
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1868 // image was created
1869 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1870 src_image_state->createInfo.arrayLayers) {
1871 std::stringstream ss;
1872 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1873 << "] baseArrayLayer + layerCount is "
1874 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1875 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001876 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1877 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001878 }
1879 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1880 dst_image_state->createInfo.arrayLayers) {
1881 std::stringstream ss;
1882 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1883 << "] baseArrayLayer + layerCount is "
1884 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
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_0a600154, "IMAGE", "%s. %s",
1887 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001888 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001889
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001890 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1891 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1892 // 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 -06001893 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(regions[i].srcSubresource));
1894 if (0 != ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001895 std::stringstream ss;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001896 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << regions[i].srcSubresource.mipLevel
1897 << " ], offset [ " << regions[i].srcOffset.x << ", " << regions[i].srcOffset.y << ", " << regions[i].srcOffset.z
1898 << " ], extent [ " << regions[i].extent.width << ", " << regions[i].extent.height << ", "
1899 << regions[i].extent.depth << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001900 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_190000f4, "IMAGE", "%s. %s",
1902 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001903 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001904
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001905 // 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 -06001906 img_extent = GetImageSubresourceExtent(dst_image_state, &(regions[i].dstSubresource));
1907 if (0 != ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001908 std::stringstream ss;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001909 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << regions[i].dstSubresource.mipLevel
1910 << " ], offset [ " << regions[i].dstOffset.x << ", " << regions[i].dstOffset.y << ", " << regions[i].dstOffset.z
1911 << " ], extent [ " << regions[i].extent.width << ", " << regions[i].extent.height << ", "
1912 << regions[i].extent.depth << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001913 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 -06001914 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1915 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001916 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001917 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001918
Dave Houltonfc1a4052017-04-27 14:32:45 -06001919 // Each dimension offset + extent limits must fall with image subresource extent
1920 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(regions[i].srcSubresource));
Dave Houlton6f9059e2017-05-02 17:15:13 -06001921 VkExtent3D copy_extent = regions[i].extent;
1922 if (slice_override) copy_extent.depth = depth_slices;
1923 uint32_t extent_check = ExceedsBounds(&(regions[i].srcOffset), &copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001924 if (extent_check & x_bit) {
1925 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 -06001926 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001927 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1928 "width [%1d]. %s",
1929 i, regions[i].srcOffset.x, regions[i].extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001930 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001931 }
1932
1933 if (extent_check & y_bit) {
1934 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 -06001935 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001936 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1937 "height [%1d]. %s",
1938 i, regions[i].srcOffset.y, regions[i].extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001939 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001940 }
1941 if (extent_check & z_bit) {
1942 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 -06001943 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001944 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1945 "depth [%1d]. %s",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001946 i, regions[i].srcOffset.z, copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001947 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001948 }
1949
1950 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(regions[i].dstSubresource));
Dave Houlton6f9059e2017-05-02 17:15:13 -06001951 copy_extent = regions[i].extent;
1952 if (slice_override) copy_extent.depth = depth_slices;
1953 extent_check = ExceedsBounds(&(regions[i].dstOffset), &copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001954 if (extent_check & x_bit) {
1955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001956 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1958 "width [%1d]. %s",
1959 i, regions[i].dstOffset.x, regions[i].extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001960 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001961 }
1962 if (extent_check & y_bit) {
1963 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 -06001964 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001965 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1966 "height [%1d]. %s",
1967 i, regions[i].dstOffset.y, regions[i].extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001968 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001969 }
1970 if (extent_check & z_bit) {
1971 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 -06001972 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001973 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1974 "depth [%1d]. %s",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001975 i, regions[i].dstOffset.z, copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001976 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001977 }
1978
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001979 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1980 // must not overlap in memory
1981 if (src_image_state->image == dst_image_state->image) {
1982 for (uint32_t j = 0; j < region_count; j++) {
1983 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1984 std::stringstream ss;
1985 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1986 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001987 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
1988 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001989 }
1990 }
1991 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001992 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001993
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001994 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1995 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1996 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06001997 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001998 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1999 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2001 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002002 }
2003 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06002004 size_t srcSize = FormatSize(src_image_state->createInfo.format);
2005 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 if (srcSize != destSize) {
2007 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2008 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 -06002009 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
2010 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002011 }
2012 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002013
Dave Houlton33c22b72017-02-28 13:16:02 -07002014 // Source and dest image sample counts must match
2015 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2016 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2017 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002018 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
2019 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07002020 }
2021
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002022 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2023 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002024 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002025 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002026 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002027 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002028 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002029 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002030 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002031 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002032 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002033 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002035 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002036 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002037 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002038 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002039 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2040 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002041 }
2042
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002043 return skip;
2044}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002045
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002046void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002047 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2048 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2049 // Make sure that all image slices are updated to correct layout
2050 for (uint32_t i = 0; i < region_count; ++i) {
2051 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2052 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2053 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002054 // Update bindings between images and cmd buffer
2055 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2056 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002057 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002058 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002059 function = [=]() {
2060 SetImageMemoryValid(device_data, dst_image_state, true);
2061 return false;
2062 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002063 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002064}
2065
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002066// Returns true if sub_rect is entirely contained within rect
2067static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2068 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2069 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2070 return false;
2071 return true;
2072}
2073
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002074bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2075 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002076 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002077 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2078
2079 bool skip = false;
2080 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002081 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2082 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002083 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002084 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002085 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002086 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2087 // 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 -07002088 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2089 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002090 skip |=
2091 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 +02002092 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002093 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
2094 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2095 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002096 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002097 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002098 }
2099
2100 // Validate that attachment is in reference list of active subpass
2101 if (cb_node->activeRenderPass) {
2102 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2103 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002104 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002105
2106 for (uint32_t i = 0; i < attachmentCount; i++) {
2107 auto clear_desc = &pAttachments[i];
2108 VkImageView image_view = VK_NULL_HANDLE;
2109
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002110 if (0 == clear_desc->aspectMask) {
2111 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 -06002112 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2113 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002114 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2115 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002116 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2117 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002118 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002119 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002120 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2121 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2122 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2123 clear_desc->colorAttachment, cb_node->activeSubpass,
2124 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002125 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2126 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002127 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2128 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002129 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2130 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002131 } else {
2132 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002133 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002134 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002135 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2136 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2137 char const str[] =
2138 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
2139 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 -06002140 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2141 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002142 }
2143 } else { // Must be depth and/or stencil
2144 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2145 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2146 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
2147 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002148 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2149 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002150 }
2151 if (!subpass_desc->pDepthStencilAttachment ||
2152 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2153 skip |= log_msg(
2154 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002155 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002156 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002157 } else {
2158 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2159 }
2160 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002161 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002162 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002163 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002164 // The rectangular region specified by a given element of pRects must be contained within the render area of
2165 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002166 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
2167 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
2168 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002169 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 -06002170 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002171 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2172 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002173 j, validation_error_map[VALIDATION_ERROR_18600020]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002174 }
2175 // The layers specified by a given element of pRects must be contained within every attachment that
2176 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002177 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002178 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2179 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002180 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002181 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 -06002182 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002183 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
2184 "pAttachment[%d]. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002185 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002186 }
2187 }
2188 }
2189 }
2190 }
2191 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002192}
2193
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002194bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002195 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002196 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002197 bool skip = false;
2198 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002199 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2200 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2201 skip |=
2202 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002203 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002204 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002205
2206 // For each region, the number of layers in the image subresource should not be zero
2207 // For each region, src and dest image aspect must be color only
2208 for (uint32_t i = 0; i < regionCount; i++) {
2209 if (pRegions[i].srcSubresource.layerCount == 0) {
2210 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002211 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 +02002212 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002213 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002214 if (pRegions[i].dstSubresource.layerCount == 0) {
2215 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002216 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 +02002217 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002218 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002219 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2220 skip |= log_msg(
2221 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002222 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002223 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002224 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002225 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002226 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2227 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2228 char const str[] =
2229 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002231 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2232 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002233 }
2234 }
2235
2236 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2237 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002238 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 +02002239 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002240 }
2241 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2242 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002243 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002244 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002245 }
2246 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2247 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2248 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 -06002249 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2250 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002251 }
2252 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2253 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2254 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 -06002255 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2256 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002257 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002258 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002259 } else {
2260 assert(0);
2261 }
2262 return skip;
2263}
2264
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002265void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2266 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002267 // Update bindings between images and cmd buffer
2268 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2269 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2270
2271 std::function<bool()> function = [=]() {
2272 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2273 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002274 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002275 function = [=]() {
2276 SetImageMemoryValid(device_data, dst_image_state, true);
2277 return false;
2278 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002279 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002280}
2281
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002282bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002283 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2284 VkImageLayout src_image_layout, VkImageLayout dst_image_layout, VkFilter filter) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002285 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2286
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002287 bool skip = false;
2288 if (cb_node && src_image_state && dst_image_state) {
2289 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002290 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002291 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002292 VALIDATION_ERROR_184001d4);
2293 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2294 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2295 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2296 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2297 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2298 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2299 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002300 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002301 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002302 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002303
Dave Houlton33c2d252017-06-09 17:08:32 -06002304 VkFormat src_format = src_image_state->createInfo.format;
2305 VkFormat dst_format = dst_image_state->createInfo.format;
2306 VkImageType src_type = src_image_state->createInfo.imageType;
2307 VkImageType dst_type = dst_image_state->createInfo.imageType;
2308
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002309 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002310 VkImageTiling tiling = src_image_state->createInfo.tiling;
2311 VkFormatFeatureFlags flags =
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002312 (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002313 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2314 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2315 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2316 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2317 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2318 }
2319
2320 if ((VK_FILTER_LINEAR == filter) &&
2321 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2322 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2323 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2324 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2325 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2326 }
2327
2328 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2329 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
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__, VALIDATION_ERROR_184001d8, "IMAGE",
2332 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2333 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2334 }
2335
2336 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2337 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2338 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2339 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2340 validation_error_map[VALIDATION_ERROR_184001da]);
2341 }
2342
2343 props = GetFormatProperties(device_data, dst_format);
2344 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002345 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002346 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2347 skip |=
2348 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2349 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2350 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2351 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2352 }
2353
2354 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2355 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2356 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2357 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2358 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2359 validation_error_map[VALIDATION_ERROR_184001c8]);
2360 }
2361
2362 // Validate consistency for unsigned formats
2363 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2364 std::stringstream ss;
2365 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2366 << "the other one must also have unsigned integer format. "
2367 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2368 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2369 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2370 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2371 }
2372
2373 // Validate consistency for signed formats
2374 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2375 std::stringstream ss;
2376 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2377 << "the other one must also have signed integer format. "
2378 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2379 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2380 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2381 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2382 }
2383
2384 // Validate filter for Depth/Stencil formats
2385 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2386 std::stringstream ss;
2387 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2388 << "then filter must be VK_FILTER_NEAREST.";
2389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2390 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d0, "IMAGE", "%s. %s",
2391 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2392 }
2393
2394 // Validate aspect bits and formats for depth/stencil images
2395 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2396 if (src_format != dst_format) {
2397 std::stringstream ss;
2398 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2399 << "stencil, the other one must have exactly the same format. "
2400 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2401 << string_VkFormat(dst_format);
2402 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2403 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2404 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2405 }
2406
2407#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2408 for (uint32_t i = 0; i < regionCount; i++) {
2409 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2410
2411 if (FormatIsDepthAndStencil(src_format)) {
2412 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2413 std::stringstream ss;
2414 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
2415 "VK_IMAGE_ASPECT_DEPTH_BIT "
2416 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2417 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2418 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2419 "%s", ss.str().c_str());
2420 }
2421 }
2422 else if (FormatIsStencilOnly(src_format)) {
2423 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2424 std::stringstream ss;
2425 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2426 << "set in both the srcImage and dstImage";
2427 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2428 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2429 "%s", ss.str().c_str());
2430 }
2431 }
2432 else if (FormatIsDepthOnly(src_format)) {
2433 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2434 std::stringstream ss;
2435 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2436 << "set in both the srcImage and dstImage";
2437 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2438 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2439 "%s", ss.str().c_str());
2440 }
2441 }
2442 }
2443#endif
2444 } // Depth or Stencil
2445
2446 // Do per-region checks
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002447 for (uint32_t i = 0; i < region_count; i++) {
2448 const VkImageBlit rgn = regions[i];
2449 bool hit_error = false;
2450 skip |=
2451 VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, src_image_layout,
2452 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001bc, &hit_error);
2453 skip |=
2454 VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dst_image_layout,
2455 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", VALIDATION_ERROR_184001c6, &hit_error);
Dave Houlton48989f32017-05-26 15:01:46 -06002456
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002457 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002458 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2459 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002460 std::stringstream ss;
2461 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2462 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 +02002463 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2464 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002465 }
Dave Houlton48989f32017-05-26 15:01:46 -06002466 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2467 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002468 std::stringstream ss;
2469 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2470 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 +02002471 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2472 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002473 }
Dave Houlton48989f32017-05-26 15:01:46 -06002474 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002475 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2476 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 +02002477 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002478 }
Dave Houlton48989f32017-05-26 15:01:46 -06002479 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002480 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2481 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 +02002482 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002483 }
2484
2485 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002486 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002487 skip |=
2488 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 -06002489 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002490 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002491 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002492 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002493
Dave Houlton48989f32017-05-26 15:01:46 -06002494 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002495 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 -06002496 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002497 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002498 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002499 }
Dave Houlton48989f32017-05-26 15:01:46 -06002500
Dave Houlton33c2d252017-06-09 17:08:32 -06002501 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2502 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2503 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2504 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2505 "image format %s. %s",
2506 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2507 validation_error_map[VALIDATION_ERROR_09a001e2]);
2508 }
2509
2510 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2511 skip |= log_msg(
2512 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2513 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2514 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2515 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2516 }
2517
Dave Houlton48989f32017-05-26 15:01:46 -06002518 // Validate source image offsets
2519 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002520 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002521 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2522 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2523 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2524 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2525 "of (%1d, %1d). These must be (0, 1). %s",
2526 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2527 }
2528 }
2529
Dave Houlton33c2d252017-06-09 17:08:32 -06002530 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002531 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2532 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2533 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2534 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2535 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2536 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2537 }
2538 }
2539
Dave Houlton33c2d252017-06-09 17:08:32 -06002540 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002541 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2542 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002543 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002544 skip |= log_msg(
2545 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2546 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2547 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2548 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2549 }
2550 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2551 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002552 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002553 skip |= log_msg(
2554 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2555 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2556 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2557 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2558 }
2559 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2560 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002561 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002562 skip |= log_msg(
2563 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2564 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2565 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2566 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2567 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002568 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2569 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2570 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2571 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2572 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2573 } else if (oob) {
2574 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2575 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2576 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2577 validation_error_map[VALIDATION_ERROR_184001ae]);
2578 }
Dave Houlton48989f32017-05-26 15:01:46 -06002579
2580 // Validate dest image offsets
2581 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002582 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002583 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2584 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2585 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2586 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2587 "(%1d, %1d). These must be (0, 1). %s",
2588 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2589 }
2590 }
2591
Dave Houlton33c2d252017-06-09 17:08:32 -06002592 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002593 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2594 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2595 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2596 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2597 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2598 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2599 }
2600 }
2601
Dave Houlton33c2d252017-06-09 17:08:32 -06002602 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002603 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2604 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002605 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002606 skip |= log_msg(
2607 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2608 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2609 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2610 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2611 }
2612 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2613 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002614 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002615 skip |= log_msg(
2616 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2617 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2618 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2619 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2620 }
2621 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2622 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002623 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002624 skip |= log_msg(
2625 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2626 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2627 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2628 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2629 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002630 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002631 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 -06002632 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2633 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2634 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2635 } else if (oob) {
2636 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2637 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2638 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2639 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002640 }
2641
Dave Houlton33c2d252017-06-09 17:08:32 -06002642 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2643 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2644 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2645 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2646 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2647 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2648 "layerCount other than 1. %s",
2649 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002650 }
2651 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002652 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002653 } else {
2654 assert(0);
2655 }
2656 return skip;
2657}
2658
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002659void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01002660 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageBlit *regions,
2661 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2662 // Make sure that all image slices are updated to correct layout
2663 for (uint32_t i = 0; i < region_count; ++i) {
2664 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2665 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2666 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002667 // Update bindings between images and cmd buffer
2668 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2669 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2670
2671 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002672 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002673 function = [=]() {
2674 SetImageMemoryValid(device_data, dst_image_state, true);
2675 return false;
2676 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002677 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002678}
2679
Tony Barbourdf013b92017-01-25 12:53:48 -07002680// This validates that the initial layout specified in the command buffer for
2681// the IMAGE is the same
2682// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002683bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002684 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const & globalImageLayoutMap,
2685 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> & overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002686 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002687 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002688 for (auto cb_image_data : pCB->imageLayoutMap) {
2689 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002690
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002691 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
2692 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002693 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2694 // TODO: Set memory invalid which is in mem_tracker currently
2695 } else if (imageLayout != cb_image_data.second.initialLayout) {
2696 if (cb_image_data.first.hasSubresource) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002697 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2698 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2699 "Cannot submit cmd buffer using image (0x%" PRIx64
2700 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
2701 "with layout %s when first use is %s.",
2702 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2703 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2704 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002705 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002706 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2707 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2708 "Cannot submit cmd buffer using image (0x%" PRIx64
2709 ") with layout %s when "
2710 "first use is %s.",
2711 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2712 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002713 }
2714 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002715 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002716 }
2717 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002718 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002719}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002720
Tony Barbourdf013b92017-01-25 12:53:48 -07002721void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2722 for (auto cb_image_data : pCB->imageLayoutMap) {
2723 VkImageLayout imageLayout;
2724 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2725 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2726 }
2727}
2728
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002729// Print readable FlagBits in FlagMask
2730static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2731 std::string result;
2732 std::string separator;
2733
2734 if (accessMask == 0) {
2735 result = "[None]";
2736 } else {
2737 result = "[";
2738 for (auto i = 0; i < 32; i++) {
2739 if (accessMask & (1 << i)) {
2740 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2741 separator = " | ";
2742 }
2743 }
2744 result = result + "]";
2745 }
2746 return result;
2747}
2748
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002749// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2750// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002751// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002752static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2753 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2754 const char *type) {
2755 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2756 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002757
2758 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2759 if (accessMask & ~(required_bit | optional_bits)) {
2760 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002761 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002762 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002763 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2764 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002765 }
2766 } else {
2767 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002768 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 +02002769 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002770 "%s AccessMask %d %s must contain at least one of access bits %d "
2771 "%s when layout is %s, unless the app has previously added a "
2772 "barrier for this transition.",
2773 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2774 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002775 } else {
2776 std::string opt_bits;
2777 if (optional_bits != 0) {
2778 std::stringstream ss;
2779 ss << optional_bits;
2780 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2781 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002782 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 +02002783 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002784 "%s AccessMask %d %s must have required access bit %d %s %s when "
2785 "layout is %s, unless the app has previously added a barrier for "
2786 "this transition.",
2787 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2788 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002789 }
2790 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002791 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002792}
2793
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002794// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002795// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2796// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002797bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002798 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2799 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002800 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2801 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2802 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2803 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002804 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 -06002805 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2806 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002807 }
2808 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002809 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002810}
2811
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002812bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2813 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002814 bool skip = false;
2815
Jason Ekstranda1906302017-12-03 20:16:32 -08002816 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
2817 VkFormat format = pCreateInfo->pAttachments[i].format;
2818 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2819 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
2820 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2821 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
2822 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2823 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
2824 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
2825 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
2826 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
2827 "image truely is undefined at the start of the render pass.");
2828 }
2829 if (FormatHasStencil(format) &&
2830 pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2831 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
2832 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2833 __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
2834 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
2835 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
2836 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
2837 "image truely is undefined at the start of the render pass.");
2838 }
2839 }
2840 }
2841
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002842 // Track when we're observing the first use of an attachment
2843 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2844 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2845 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002846
2847 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2848 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2849 auto attach_index = subpass.pInputAttachments[j].attachment;
2850 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2851
2852 switch (subpass.pInputAttachments[j].layout) {
2853 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2854 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2855 // These are ideal.
2856 break;
2857
2858 case VK_IMAGE_LAYOUT_GENERAL:
2859 // May not be optimal. TODO: reconsider this warning based on other constraints.
2860 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2861 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2862 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2863 break;
2864
2865 default:
2866 // No other layouts are acceptable
2867 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2868 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2869 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2870 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2871 }
2872
2873 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2874 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2875 subpass.pDepthStencilAttachment->attachment == attach_index &&
2876 subpass.pDepthStencilAttachment->layout != layout;
2877 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2878 found_layout_mismatch =
2879 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2880 }
2881 if (found_layout_mismatch) {
2882 skip |= log_msg(
2883 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002884 VALIDATION_ERROR_140006ae, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002885 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a depth/color "
2886 "attachment with a different layout. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002887 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002888 }
2889
2890 if (attach_first_use[attach_index]) {
2891 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2892 pCreateInfo->pAttachments[attach_index]);
2893
2894 bool used_as_depth =
2895 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2896 bool used_as_color = false;
2897 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2898 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2899 }
2900 if (!used_as_depth && !used_as_color &&
2901 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2902 skip |= log_msg(
2903 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002904 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002905 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002906 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002907 }
2908 }
2909 attach_first_use[attach_index] = false;
2910 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002911 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2912 auto attach_index = subpass.pColorAttachments[j].attachment;
2913 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2914
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002915 // TODO: Need a way to validate shared presentable images here, currently just allowing
2916 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2917 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002918 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002919 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002920 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002921 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2922 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002923 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002924
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002925 case VK_IMAGE_LAYOUT_GENERAL:
2926 // May not be optimal; TODO: reconsider this warning based on other constraints?
2927 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2928 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2929 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2930 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002931
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002932 default:
2933 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2934 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2935 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2936 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002937 }
2938
2939 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002940 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2941 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002942 }
2943 attach_first_use[attach_index] = false;
2944 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002945
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002946 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2947 switch (subpass.pDepthStencilAttachment->layout) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06002948 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2949 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2950 // These are ideal.
2951 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002952
Lenny Komowb79f04a2017-09-18 17:07:00 -06002953 case VK_IMAGE_LAYOUT_GENERAL:
2954 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2955 // doing a bunch of transitions.
2956 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2957 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2958 "GENERAL layout for depth attachment may not give optimal performance.");
2959 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002960
Lenny Komowb79f04a2017-09-18 17:07:00 -06002961 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2962 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2963 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2964 break;
2965 } else {
2966 // Intentionally fall through to generic error message
2967 }
2968
2969 default:
2970 // No other layouts are acceptable
2971 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2972 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2973 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2974 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2975 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002976 }
2977
2978 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2979 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002980 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2981 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002982 }
2983 attach_first_use[attach_index] = false;
2984 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002985 }
2986 return skip;
2987}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002988
2989// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002990bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2991 VkDeviceSize offset, VkDeviceSize end_offset) {
2992 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2993 bool skip = false;
2994 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2995 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002996 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2997 for (auto image_handle : mem_info->bound_images) {
2998 auto img_it = mem_info->bound_ranges.find(image_handle);
2999 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003000 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003001 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003002 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003003 for (auto layout : layouts) {
3004 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003005 skip |=
3006 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
3007 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
3008 "Mapping an image with layout %s can result in undefined behavior if this memory is "
3009 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
3010 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003011 }
3012 }
3013 }
3014 }
3015 }
3016 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003017 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003018}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003019
3020// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3021// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003022static 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 -06003023 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003024 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003025
3026 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003027 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003028 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003029 if (strict) {
3030 correct_usage = ((actual & desired) == desired);
3031 } else {
3032 correct_usage = ((actual & desired) != 0);
3033 }
3034 if (!correct_usage) {
3035 if (msgCode == -1) {
3036 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06003037 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 -06003038 MEMTRACK_INVALID_USAGE_FLAG, "MEM",
3039 "Invalid usage flag for %s 0x%" PRIxLEAST64
3040 " used by %s. In this case, %s should have %s set during creation.",
3041 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003042 } else {
3043 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski33826372017-04-13 11:10:11 -06003044 skip = log_msg(
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06003045 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 -06003046 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation. %s",
3047 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003048 }
3049 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003050 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003051}
3052
3053// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3054// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003055bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003056 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003057 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3058 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003059}
3060
3061// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3062// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003063bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003064 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003065 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3066 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003067}
3068
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003069bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003070 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003071 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3072
Chris Forbese0f511c2017-06-14 12:38:01 -07003073 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003074
3075 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3076 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 -06003077 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003078 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3079 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003080 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003081 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003082
3083 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
3084 skip |=
3085 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 -07003086 VALIDATION_ERROR_01400728, "DS",
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003087 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003088 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3089 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003090 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003091
3092 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
3093 skip |=
3094 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 -07003095 VALIDATION_ERROR_0140072a, "DS",
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003096 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003097 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3098 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003099 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003100 return skip;
3101}
3102
3103void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3104 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3105 GetBufferMap(device_data)
3106 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3107}
3108
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003109bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3110 bool skip = false;
3111 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003112 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3113 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003114 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003115 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3116 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003117 skip |= ValidateBufferUsageFlags(
3118 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 -06003119 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003120 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003121 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003122}
3123
3124void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3125 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3126}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003127
3128// For the given format verify that the aspect masks make sense
3129bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3130 const char *func_name) {
3131 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3132 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003133 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003134 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003135 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 -06003136 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003137 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003138 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003139 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003140 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 -06003141 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003142 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003143 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003144 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003145 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003146 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003147 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 -06003148 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003149 "%s: Depth/stencil image formats must have "
3150 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
3151 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003152 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003153 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003154 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003155 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003156 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3157 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003158 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003159 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003160 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003161 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003162 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 -06003163 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003164 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003165 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003166 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003167 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 -06003168 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003169 "%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 -06003170 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003171 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003172 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003173 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003174 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003175 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003176 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003177 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003178 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003179 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 -06003180 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003181 "%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 -06003182 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003183 }
3184 }
3185 return skip;
3186}
3187
Petr Krausffa94af2017-08-08 21:46:02 +02003188struct SubresourceRangeErrorCodes {
3189 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3190};
3191
3192bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3193 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3194 const char *image_layer_count_var_name, const uint64_t image_handle,
3195 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003196 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3197 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003198
3199 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003200 if (subresourceRange.baseMipLevel >= image_mip_count) {
3201 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3202 errorCodes.base_mip_err, "IMAGE",
3203 "%s: %s.baseMipLevel (= %" PRIu32
3204 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 "). %s",
3205 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count,
3206 validation_error_map[errorCodes.base_mip_err]);
3207 }
Petr Kraus4d718682017-05-18 03:38:41 +02003208
Petr Krausffa94af2017-08-08 21:46:02 +02003209 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3210 if (subresourceRange.levelCount == 0) {
3211 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3212 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0. %s", cmd_name, param_name,
3213 validation_error_map[errorCodes.mip_count_err]);
3214 } else {
3215 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003216
Petr Krausffa94af2017-08-08 21:46:02 +02003217 if (necessary_mip_count > image_mip_count) {
3218 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3219 __LINE__, errorCodes.mip_count_err, "IMAGE",
3220 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3221 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3222 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
3223 necessary_mip_count, image_mip_count, validation_error_map[errorCodes.mip_count_err]);
3224 }
Petr Kraus4d718682017-05-18 03:38:41 +02003225 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003226 }
Petr Kraus4d718682017-05-18 03:38:41 +02003227
3228 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003229 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3230 skip |=
3231 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3232 errorCodes.base_layer_err, "IMAGE",
3233 "%s: %s.baseArrayLayer (= %" PRIu32
3234 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 "). %s",
3235 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count,
3236 validation_error_map[errorCodes.base_layer_err]);
3237 }
Petr Kraus4d718682017-05-18 03:38:41 +02003238
Petr Krausffa94af2017-08-08 21:46:02 +02003239 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3240 if (subresourceRange.layerCount == 0) {
3241 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3242 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0. %s", cmd_name, param_name,
3243 validation_error_map[errorCodes.layer_count_err]);
3244 } else {
3245 const uint64_t necessary_layer_count =
3246 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003247
Petr Krausffa94af2017-08-08 21:46:02 +02003248 if (necessary_layer_count > image_layer_count) {
3249 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3250 __LINE__, errorCodes.layer_count_err, "IMAGE",
3251 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3252 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3253 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
3254 necessary_layer_count, image_layer_count_var_name, image_layer_count,
3255 validation_error_map[errorCodes.layer_count_err]);
3256 }
Petr Kraus4d718682017-05-18 03:38:41 +02003257 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003258 }
Petr Kraus4d718682017-05-18 03:38:41 +02003259
Mark Lobodzinski602de982017-02-09 11:01:33 -07003260 return skip;
3261}
3262
Petr Krausffa94af2017-08-08 21:46:02 +02003263bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3264 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3265 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3266 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3267 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3268 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3269
3270 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3271 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3272
3273 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3274 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
3275 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00b8e;
3276 subresourceRangeErrorCodes.base_layer_err =
3277 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3278 subresourceRangeErrorCodes.layer_count_err =
3279 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00b92;
3280
3281 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3282 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3283 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3284}
3285
3286bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3287 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3288 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3289 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
3290 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800b7e;
3291 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
3292 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800b82;
3293
3294 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3295 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3296 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3297}
3298
3299bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3300 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3301 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3302 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
3303 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00b86;
3304 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
3305 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00b8a;
3306
3307 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3308 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3309 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3310}
3311
3312bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3313 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3314 const char *param_name) {
3315 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3316 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
3317 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000b9e;
3318 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
3319 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000ba2;
3320
3321 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3322 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3323 subresourceRangeErrorCodes);
3324}
3325
Mark Lobodzinski602de982017-02-09 11:01:33 -07003326bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3327 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3328 bool skip = false;
3329 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3330 if (image_state) {
3331 skip |= ValidateImageUsageFlags(
3332 device_data, image_state,
3333 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06003334 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003335 false, -1, "vkCreateImageView()",
3336 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3337 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003338 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003339 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003340 skip |= ValidateCreateImageViewSubresourceRange(
3341 device_data, image_state,
3342 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3343 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003344
3345 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3346 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003347 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3348 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003349 VkFormat view_format = create_info->format;
3350 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003351 VkImageType image_type = image_state->createInfo.imageType;
3352 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003353
3354 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3355 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003356 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3357 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3358 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3359 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3360 std::stringstream ss;
3361 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3362 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3363 << ") format " << string_VkFormat(image_format)
3364 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3365 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3366 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3367 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3368 validation_error_map[VALIDATION_ERROR_0ac007f4]);
3369 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003370 }
3371 } else {
3372 // Format MUST be IDENTICAL to the format the image was created with
3373 if (image_format != view_format) {
3374 std::stringstream ss;
3375 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003376 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003377 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003378 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 -06003379 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3380 validation_error_map[VALIDATION_ERROR_0ac007f6]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003381 }
3382 }
3383
3384 // Validate correct image aspect bits for desired formats and format consistency
3385 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003386
3387 switch (image_type) {
3388 case VK_IMAGE_TYPE_1D:
3389 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3390 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3391 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3392 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3393 string_VkImageViewType(view_type), string_VkImageType(image_type),
3394 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3395 }
3396 break;
3397 case VK_IMAGE_TYPE_2D:
3398 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3399 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3400 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3401 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3402 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
3403 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3404 string_VkImageViewType(view_type), string_VkImageType(image_type),
3405 validation_error_map[VALIDATION_ERROR_0ac007d6]);
3406 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3408 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3409 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3410 string_VkImageViewType(view_type), string_VkImageType(image_type),
3411 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3412 }
3413 }
3414 break;
3415 case VK_IMAGE_TYPE_3D:
3416 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3417 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3418 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3419 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
3420 skip |= log_msg(
3421 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3422 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3423 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3424 string_VkImageViewType(view_type), string_VkImageType(image_type),
3425 validation_error_map[VALIDATION_ERROR_0ac007da]);
3426 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3427 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
3428 skip |= log_msg(
3429 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3430 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3431 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s when the "
3432 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
3433 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled. %s",
3434 string_VkImageViewType(view_type), string_VkImageType(image_type),
3435 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3436 }
3437 } else {
3438 skip |=
3439 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3440 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3441 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3442 string_VkImageViewType(view_type), string_VkImageType(image_type),
3443 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3444 }
3445 }
3446 } else {
3447 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3448 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3449 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3450 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3451 string_VkImageViewType(view_type), string_VkImageType(image_type),
3452 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3453 }
3454 }
3455 break;
3456 default:
3457 break;
3458 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003459
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003460 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003461 bool check_tiling_features = false;
3462 VkFormatFeatureFlags tiling_features = 0;
3463 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3464 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3465 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3466 };
3467 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3468 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3469 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3470 };
3471 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3472 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003473 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003474 error_codes = linear_error_codes;
3475 check_tiling_features = true;
3476 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003477 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003478 error_codes = optimal_error_codes;
3479 check_tiling_features = true;
3480 }
3481
3482 if (check_tiling_features) {
3483 if (tiling_features == 0) {
3484 skip |=
3485 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3486 error_codes[0], "IMAGE",
3487 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3488 "%s flag set. %s",
3489 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[0]]);
3490 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
3491 skip |=
3492 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3493 error_codes[1], "IMAGE",
3494 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3495 "%s and VK_IMAGE_USAGE_SAMPLED_BIT flags set. %s",
3496 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[1]]);
3497 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
3498 skip |=
3499 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3500 error_codes[2], "IMAGE",
3501 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3502 "%s and VK_IMAGE_USAGE_STORAGE_BIT flags set. %s",
3503 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[2]]);
3504 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3505 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
3506 skip |=
3507 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3508 error_codes[3], "IMAGE",
3509 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3510 "%s and VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set. %s",
3511 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[3]]);
3512 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3513 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
3514 skip |=
3515 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3516 error_codes[4], "IMAGE",
3517 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3518 "%s and VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set. %s",
3519 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[4]]);
3520 }
3521 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003522 }
3523 return skip;
3524}
3525
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003526void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3527 auto image_view_map = GetImageViewMap(device_data);
3528 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3529
3530 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003531 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003532 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3533 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003534}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003535
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003536bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3537 BUFFER_STATE *dst_buffer_state) {
3538 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003539 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3540 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003541 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003542 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3543 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3544 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3545 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003546 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003547 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003548 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003549 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003550 return skip;
3551}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003552
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003553void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3554 BUFFER_STATE *dst_buffer_state) {
3555 // Update bindings between buffers and cmd buffer
3556 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3557 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3558
3559 std::function<bool()> function = [=]() {
3560 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3561 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003562 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003563 function = [=]() {
3564 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3565 return false;
3566 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003567 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003568}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003569
3570static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3571 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3572 bool skip = false;
3573 auto buffer_state = GetBufferState(device_data, buffer);
3574 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003575 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 -07003576 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
Petr Krausbc7f5442017-05-14 23:43:38 +02003577 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003578 } else {
3579 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003580 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 -06003581 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Krausbc7f5442017-05-14 23:43:38 +02003582 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003583 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003584 }
3585 }
3586 return skip;
3587}
3588
3589bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3590 VK_OBJECT *obj_struct) {
3591 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003592 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003593 if (GetDisables(device_data)->destroy_image_view) return false;
3594 bool skip = false;
3595 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003596 skip |=
3597 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003598 }
3599 return skip;
3600}
3601
3602void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3603 VK_OBJECT obj_struct) {
3604 // Any bound cmd buffers are now invalid
3605 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3606 (*GetImageViewMap(device_data)).erase(image_view);
3607}
3608
3609bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3610 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003611 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003612 if (GetDisables(device_data)->destroy_buffer) return false;
3613 bool skip = false;
3614 if (*buffer_state) {
3615 skip |= validateIdleBuffer(device_data, buffer);
3616 }
3617 return skip;
3618}
3619
3620void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3621 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3622 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3623 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3624 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003625 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003626 }
3627 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003628 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003629 GetBufferMap(device_data)->erase(buffer_state->buffer);
3630}
3631
3632bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3633 VK_OBJECT *obj_struct) {
3634 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003635 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003636 if (GetDisables(device_data)->destroy_buffer_view) return false;
3637 bool skip = false;
3638 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003639 skip |=
3640 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003641 }
3642 return skip;
3643}
3644
3645void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3646 VK_OBJECT obj_struct) {
3647 // Any bound cmd buffers are now invalid
3648 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3649 GetBufferViewMap(device_data)->erase(buffer_view);
3650}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003651
3652bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3653 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003654 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003655 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003656 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003657 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3658 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003659 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003660 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003661 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003662 return skip;
3663}
3664
3665void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3666 std::function<bool()> function = [=]() {
3667 SetBufferMemoryValid(device_data, buffer_state, true);
3668 return false;
3669 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003670 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003671 // Update bindings between buffer and cmd buffer
3672 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003673}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003674
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003675bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3676 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003677 bool skip = false;
3678
3679 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003680 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3681 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003682 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 -06003683 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003684 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
3685 "must be 0 and 1, respectively. %s",
3686 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003687 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003688 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003689 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003690
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003691 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3692 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003693 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 -06003694 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003695 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3696 "must be 0 and 1, respectively. %s",
3697 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003698 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003699 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003700 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003701
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003702 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3703 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3704 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 -06003705 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003706 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
3707 "%d. For 3D images these must be 0 and 1, respectively. %s",
3708 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003709 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003710 }
3711 }
3712
3713 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3714 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003715 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003716 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003717 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 -06003718 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003719 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3720 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003721 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003722 }
3723
3724 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003725 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003726 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 -06003727 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003728 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003729 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003730 }
3731
3732 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3733 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3734 skip |= log_msg(
3735 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003736 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003737 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3738 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003739 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003740 }
3741
3742 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3743 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3744 skip |= log_msg(
3745 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003746 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003747 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3748 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003749 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003750 }
3751
3752 // subresource aspectMask must have exactly 1 bit set
3753 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3754 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3755 if (aspect_mask_bits.count() != 1) {
3756 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 -06003757 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003758 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003759 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003760 }
3761
3762 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003763 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003764 skip |= log_msg(
3765 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003766 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003767 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3768 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003769 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003770 }
3771
3772 // Checks that apply only to compressed images
3773 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3774 // reserves a place for these compressed image checks. This block of code could move there once the image
3775 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003776 if (FormatIsCompressed(image_state->createInfo.format)) {
3777 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003778
3779 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003780 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003781 skip |= log_msg(
3782 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003783 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003784 "%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 -06003785 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003786 }
3787
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003788 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003789 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003790 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003791 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003792 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
3793 "height (%d). %s.",
3794 function, i, pRegions[i].bufferImageHeight, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003795 validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003796 }
3797
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003798 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003799 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3800 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3801 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003802 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 -06003803 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003804 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3805 "width & height (%d, %d). %s.",
3806 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003807 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003808 }
3809
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003810 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003811 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3812 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003813 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 -06003814 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003815 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3816 ") must be a multiple of the compressed image's texel block "
3817 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3818 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003819 validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003820 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003821
3822 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003823 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003824 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003825 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3826 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 -06003827 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003828 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3829 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3830 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003831 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003832 }
3833
3834 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003835 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003836 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3837 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 -06003838 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003839 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3840 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3841 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003842 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003843 }
3844
3845 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003846 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003847 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3848 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 -06003849 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003850 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3851 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3852 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003853 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003854 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003855 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003856 }
3857
3858 return skip;
3859}
3860
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003861static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3862 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003863 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003864 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003865
3866 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003867 VkExtent3D extent = pRegions[i].imageExtent;
3868 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003869
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003870 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3871 {
3872 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3873 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3874 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3875 extent.height, extent.depth);
3876 }
3877
3878 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3879
3880 // 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 -06003881 if (FormatIsCompressed(image_info->format)) {
3882 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003883 if (image_extent.width % block_extent.width) {
3884 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3885 }
3886 if (image_extent.height % block_extent.height) {
3887 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3888 }
3889 if (image_extent.depth % block_extent.depth) {
3890 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3891 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003892 }
3893
Dave Houltonfc1a4052017-04-27 14:32:45 -06003894 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003895 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 -07003896 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003897 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003898 }
3899 }
3900
3901 return skip;
3902}
3903
Chris Forbese8ba09a2017-06-01 17:39:02 -07003904static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003905 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3906 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003907 bool skip = false;
3908
3909 VkDeviceSize buffer_size = buff_state->createInfo.size;
3910
3911 for (uint32_t i = 0; i < regionCount; i++) {
3912 VkExtent3D copy_extent = pRegions[i].imageExtent;
3913
3914 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3915 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003916 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003917
Dave Houltonf3229d52017-02-21 15:59:08 -07003918 // Handle special buffer packing rules for specific depth/stencil formats
3919 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003920 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003921 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3922 switch (image_state->createInfo.format) {
3923 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003924 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003925 break;
3926 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003927 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003928 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003929 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003930 case VK_FORMAT_D24_UNORM_S8_UINT:
3931 unit_size = 4;
3932 break;
3933 default:
3934 break;
3935 }
3936 }
3937
Dave Houlton1d2022c2017-03-29 11:43:58 -06003938 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003939 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003940 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003941 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3942 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3943
3944 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3945 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3946 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003947 }
3948
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003949 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3950 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3951 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003952 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003953 } else {
3954 // Calculate buffer offset of final copied byte, + 1.
3955 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3956 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3957 max_buffer_offset *= unit_size; // convert to bytes
3958 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003959
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003960 if (buffer_size < max_buffer_offset) {
3961 skip |=
3962 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3963 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
3964 i, buffer_size, validation_error_map[msg_code]);
3965 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003966 }
3967 }
3968
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003969 return skip;
3970}
3971
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003972bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003973 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003974 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003975 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3976 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3977
3978 // Validate command buffer state
3979 if (CB_RECORDING != cb_node->state) {
3980 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 -06003981 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_19202413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003982 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003983 validation_error_map[VALIDATION_ERROR_19202413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003984 } else {
3985 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
3986 }
3987
3988 // Command pool must support graphics, compute, or transfer operations
3989 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3990
3991 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3992 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3993 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 -06003994 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003995 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
3996 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003997 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003998 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003999 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004000 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004001 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004002 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004003
4004 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004005 VALIDATION_ERROR_19200178);
4006 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
4007 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004008
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004009 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004010 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004011 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004012 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4013 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
4014 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004015 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004016 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004017 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
4018 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
4019 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004020 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06004021 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004022 }
4023 return skip;
4024}
4025
4026void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004027 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
4028 VkImageLayout src_image_layout) {
4029 // Make sure that all image slices are updated to correct layout
4030 for (uint32_t i = 0; i < region_count; ++i) {
4031 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
4032 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004033 // Update bindings between buffer/image and cmd buffer
4034 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004035 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004036
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004037 std::function<bool()> function = [=]() {
4038 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
4039 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004040 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004041 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004042 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004043 return false;
4044 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004045 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004046}
4047
4048bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004049 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004050 const VkBufferImageCopy *pRegions, const char *func_name) {
4051 const debug_report_data *report_data = core_validation::GetReportData(device_data);
4052 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4053
4054 // Validate command buffer state
4055 if (CB_RECORDING != cb_node->state) {
4056 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 -06004057 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_18e02413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004058 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004059 validation_error_map[VALIDATION_ERROR_18e02413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004060 } else {
4061 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
4062 }
4063
4064 // Command pool must support graphics, compute, or transfer operations
4065 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4066 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4067 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4068 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 -06004069 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004070 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
4071 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004072 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004073 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004074 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004075 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004076 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004077 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004078 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004079 VALIDATION_ERROR_18e00166);
4080 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4081 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4082 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4083 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4084 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004085 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004086 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004087 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004088 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004089 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4090 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4091 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004092 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4093 "vkCmdCopyBufferToImage()");
4094 }
4095 return skip;
4096}
4097
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004098void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004099 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4100 VkImageLayout dst_image_layout) {
4101 // Make sure that all image slices are updated to correct layout
4102 for (uint32_t i = 0; i < region_count; ++i) {
4103 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4104 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004105 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004106 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004107 std::function<bool()> function = [=]() {
4108 SetImageMemoryValid(device_data, dst_image_state, true);
4109 return false;
4110 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004111 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004112 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004113 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004114}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004115
4116bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4117 const auto report_data = core_validation::GetReportData(device_data);
4118 bool skip = false;
4119 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4120
4121 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
4122 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4123 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4124 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004125 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 -06004126 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004127 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004128 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004129 }
4130
4131 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4132 if (!image_entry) {
4133 return skip;
4134 }
4135
4136 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
4137 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004138 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 -06004139 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004140 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004141 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004142 }
4143
4144 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
4145 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004146 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 -06004147 __LINE__, VALIDATION_ERROR_0a4007cc, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004148 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004149 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_0a4007cc]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004150 }
4151
4152 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
4153 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004154 skip |=
4155 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4156 __LINE__, VALIDATION_ERROR_0a4007ce, "IMAGE",
4157 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
4158 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_0a4007ce]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004159 }
4160
4161 // VU 00741: subresource's aspect must be compatible with image's format.
4162 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d2022c2017-03-29 11:43:58 -06004163 if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004164 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
4165 skip |= log_msg(
Petr Krausbc7f5442017-05-14 23:43:38 +02004166 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 -06004167 VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004168 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004169 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004170 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004171 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004172 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004173 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 -06004174 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004175 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
4176 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004177 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004178 }
4179 }
4180 return skip;
4181}