blob: 37cceb5185ab43407fb1c0104282a8243da16d41 [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 }
1103 }
1104 return skip;
1105}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001106
1107// Returns true if [x, xoffset] and [y, yoffset] overlap
1108static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1109 bool result = false;
1110 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1111 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1112
1113 if (intersection_max > intersection_min) {
1114 result = true;
1115 }
1116 return result;
1117}
1118
1119// Returns true if two VkImageCopy structures overlap
1120static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1121 bool result = false;
1122 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1123 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1124 dst->dstSubresource.layerCount))) {
1125 result = true;
1126 switch (type) {
1127 case VK_IMAGE_TYPE_3D:
1128 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1129 // Intentionally fall through to 2D case
1130 case VK_IMAGE_TYPE_2D:
1131 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1132 // Intentionally fall through to 1D case
1133 case VK_IMAGE_TYPE_1D:
1134 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1135 break;
1136 default:
1137 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1138 assert(false);
1139 }
1140 }
1141 return result;
1142}
1143
Dave Houltonfc1a4052017-04-27 14:32:45 -06001144// Returns non-zero if offset and extent exceed image extents
1145static const uint32_t x_bit = 1;
1146static const uint32_t y_bit = 2;
1147static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001148static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001149 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001150 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001151 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1152 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001153 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001154 }
1155 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1156 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001157 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001158 }
1159 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1160 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001161 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001162 }
1163 return result;
1164}
1165
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001166// Test if two VkExtent3D structs are equivalent
1167static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1168 bool result = true;
1169 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1170 (extent->depth != other_extent->depth)) {
1171 result = false;
1172 }
1173 return result;
1174}
1175
Dave Houlton6f9059e2017-05-02 17:15:13 -06001176// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001177static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1178 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001179
1180 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001181 if (mip >= img->createInfo.mipLevels) {
1182 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001183 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001184
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001185 // 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 -06001186 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001187 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1188 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1189 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Dave Houltonfc1a4052017-04-27 14:32:45 -06001190
Dave Houlton6f9059e2017-05-02 17:15:13 -06001191 // Image arrays have an effective z extent that isn't diminished by mip level
1192 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001193 extent.depth = img->createInfo.arrayLayers;
1194 }
1195
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001196 return extent;
1197}
1198
1199// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001200static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001201 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1202}
1203
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001204// Test if the extent argument has any dimensions set to 0.
1205static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1206 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1207}
1208
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001209// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1210static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1211 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1212 VkExtent3D granularity = {0, 0, 0};
1213 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1214 if (pPool) {
1215 granularity =
1216 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001217 if (FormatIsCompressed(img->createInfo.format)) {
1218 auto block_size = FormatCompressedTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001219 granularity.width *= block_size.width;
1220 granularity.height *= block_size.height;
1221 }
1222 }
1223 return granularity;
1224}
1225
1226// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1227static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1228 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001229 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1230 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001231 valid = false;
1232 }
1233 return valid;
1234}
1235
1236// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1237static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1238 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1239 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1240 bool skip = false;
1241 VkExtent3D offset_extent = {};
1242 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1243 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1244 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001245 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001246 // 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 -07001247 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001248 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1249 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1250 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1251 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1252 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001253 }
1254 } else {
1255 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1256 // integer multiples of the image transfer granularity.
1257 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001258 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1259 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1260 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1261 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1262 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1263 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001264 }
1265 }
1266 return skip;
1267}
1268
1269// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1270static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1271 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001272 const VkImageType image_type, const uint32_t i, const char *function, const char *member) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001273 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1274 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001275 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001276 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1277 // subresource extent.
1278 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001279 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1280 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1281 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1282 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1283 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1284 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001285 }
1286 } else {
1287 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1288 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1289 // subresource extent dimensions.
1290 VkExtent3D offset_extent_sum = {};
1291 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1292 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1293 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001294 bool x_ok = true;
1295 bool y_ok = true;
1296 bool z_ok = true;
1297 switch (image_type) {
1298 case VK_IMAGE_TYPE_3D:
1299 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1300 (subresource_extent->depth == offset_extent_sum.depth));
1301 // Intentionally fall through to 2D case
1302 case VK_IMAGE_TYPE_2D:
1303 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1304 (subresource_extent->height == offset_extent_sum.height));
1305 // Intentionally fall through to 1D case
1306 case VK_IMAGE_TYPE_1D:
1307 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1308 (subresource_extent->width == offset_extent_sum.width));
1309 break;
1310 default:
1311 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1312 assert(false);
1313 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001314 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001315 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001316 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 +02001317 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001318 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1319 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1320 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1321 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1322 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1323 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1324 }
1325 }
1326 return skip;
1327}
1328
1329// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1330static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1331 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1332 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1333
1334 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001335 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001336 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 +02001337 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001338 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1339 "transfer granularity width (%d).",
1340 function, i, member, value, granularity);
1341 }
1342 return skip;
1343}
1344
1345// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1346static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1347 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1348 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1349 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001350 if (SafeModulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001351 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02001352 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001353 "%s: pRegion[%d].%s (%" PRIdLEAST64
1354 ") must be an even integer multiple of this command buffer's queue family image transfer "
1355 "granularity width (%d).",
1356 function, i, member, value, granularity);
1357 }
1358 return skip;
1359}
1360
1361// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1362bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1363 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1364 const uint32_t i, const char *function) {
1365 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001366 if (FormatIsCompressed(img->createInfo.format) == true) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001367 // TODO: Add granularity checking for compressed formats
1368
1369 // bufferRowLength must be a multiple of the compressed texel block width
1370 // bufferImageHeight must be a multiple of the compressed texel block height
1371 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1372 // bufferOffset must be a multiple of the compressed texel block size in bytes
1373 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1374 // must equal the image subresource width
1375 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1376 // must equal the image subresource height
1377 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1378 // must equal the image subresource depth
1379 } else {
1380 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1381 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1382 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1383 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1384 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1385 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1386 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001387 img->createInfo.imageType, i, function, "imageExtent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001388 }
1389 return skip;
1390}
1391
1392// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1393bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
Dave Houlton6f9059e2017-05-02 17:15:13 -06001394 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
1395 const VkImageCopy *region, const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001396 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001397 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001398 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001399 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001400 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001401 VkExtent3D extent = region->extent;
1402 if (FormatIsCompressed(src_img->createInfo.format) && !FormatIsCompressed(dst_img->createInfo.format)) {
1403 // Src is compressed and dest is uncompressed, adjust extent:
1404 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_img->createInfo.format);
1405 extent.width /= block_size.width;
1406 extent.height /= block_size.height;
1407 }
1408 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001409 src_img->createInfo.imageType, i, function, "extent");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001410
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001411 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06001412 granularity = GetScaledItg(device_data, cb_node, dst_img);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001413 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
Dave Houlton6f9059e2017-05-02 17:15:13 -06001414 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001415 if (!FormatIsCompressed(src_img->createInfo.format) && FormatIsCompressed(dst_img->createInfo.format)) {
1416 // Src is uncompressed and dest is compressed, adjust extent:
1417 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_img->createInfo.format);
1418 extent.width *= block_size.width;
1419 extent.height *= block_size.height;
1420 }
1421 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->dstOffset, &granularity, &subresource_extent,
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001422 dst_img->createInfo.imageType, i, function, "extent");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001423 return skip;
1424}
1425
Dave Houlton6f9059e2017-05-02 17:15:13 -06001426// Validate contents of a VkImageCopy struct
1427bool ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data, const uint32_t regionCount,
1428 const VkImageCopy *ic_regions, const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state) {
1429 bool skip = false;
1430
1431 for (uint32_t i = 0; i < regionCount; i++) {
1432 VkImageCopy image_copy = ic_regions[i];
1433 bool slice_override = false;
1434 uint32_t depth_slices = 0;
1435
1436 // Special case for copying between a 1D/2D array and a 3D image
1437 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1438 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
1439 depth_slices = image_copy.dstSubresource.layerCount; // Slice count from 2D subresource
1440 slice_override = (depth_slices != 1);
1441 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
1442 depth_slices = image_copy.srcSubresource.layerCount; // Slice count from 2D subresource
1443 slice_override = (depth_slices != 1);
1444 }
1445
1446 // Do all checks on source image
1447 //
1448 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
1449 if ((0 != image_copy.srcOffset.y) || (1 != image_copy.extent.height)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001450 skip |=
1451 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1452 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00124, "IMAGE",
1453 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
1454 "be 0 and 1, respectively. %s",
1455 i, image_copy.srcOffset.y, image_copy.extent.height, validation_error_map[VALIDATION_ERROR_09c00124]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001456 }
1457 }
1458
1459 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (src_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
1460 if ((0 != image_copy.srcOffset.z) || (1 != image_copy.extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001461 skip |=
1462 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1463 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00128, "IMAGE",
1464 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1465 "these must be 0 and 1, respectively. %s",
1466 i, image_copy.srcOffset.z, image_copy.extent.depth, validation_error_map[VALIDATION_ERROR_09c00128]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001467 }
1468 }
1469
1470 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001471 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001472 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1473 if ((0 != image_copy.srcSubresource.baseArrayLayer) || (1 != image_copy.srcSubresource.layerCount)) {
1474 skip |=
1475 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001476 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001477 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
1478 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1479 i, image_copy.srcSubresource.baseArrayLayer, image_copy.srcSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001480 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001481 }
1482 }
1483 } else { // Pre maint 1
1484 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1485 if ((0 != image_copy.srcSubresource.baseArrayLayer) || (1 != image_copy.srcSubresource.layerCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001486 skip |=
1487 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1488 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1489 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
1490 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
1491 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
1492 i, image_copy.srcSubresource.baseArrayLayer, image_copy.srcSubresource.layerCount,
1493 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001494 }
1495 }
1496 }
1497
1498 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
1499 if ((image_copy.srcSubresource.baseArrayLayer >= src_state->createInfo.arrayLayers) ||
1500 (image_copy.srcSubresource.baseArrayLayer + image_copy.srcSubresource.layerCount > src_state->createInfo.arrayLayers)) {
1501 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 -06001502 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0012a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001503 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer (%d) must be less than the source image's "
1504 "arrayLayers (%d), and the sum of baseArrayLayer and srcSubresource.layerCount (%d) must be less than "
1505 "or equal to the source image's arrayLayers. %s",
1506 i, image_copy.srcSubresource.baseArrayLayer, src_state->createInfo.arrayLayers,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001507 image_copy.srcSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c0012a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001508 }
1509
1510 // Checks that apply only to compressed images
1511 if (FormatIsCompressed(src_state->createInfo.format)) {
1512 VkExtent3D block_size = FormatCompressedTexelBlockExtent(src_state->createInfo.format);
1513
1514 // image offsets must be multiples of block dimensions
1515 if ((SafeModulo(image_copy.srcOffset.x, block_size.width) != 0) ||
1516 (SafeModulo(image_copy.srcOffset.y, block_size.height) != 0) ||
1517 (SafeModulo(image_copy.srcOffset.z, block_size.depth) != 0)) {
1518 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 -06001519 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001520 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
1521 "texel width & height (%d, %d). %s.",
1522 i, image_copy.srcOffset.x, image_copy.srcOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001523 validation_error_map[VALIDATION_ERROR_09c0013a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001524 }
1525
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001526 // Extent width must be a multiple of block width, or extent+offset width must equal subresource width
1527 VkExtent3D adj_extent = image_copy.extent;
1528 if (!FormatIsCompressed(dst_state->createInfo.format)) {
1529 // Copying from compressed source. Modify extent to be extent / texel block size
1530 adj_extent.width /= block_size.width;
1531 adj_extent.height /= block_size.height;
1532 }
1533
Dave Houlton6f9059e2017-05-02 17:15:13 -06001534 VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(image_copy.srcSubresource));
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001535 if ((SafeModulo(adj_extent.width, block_size.width) != 0) &&
1536 (adj_extent.width + image_copy.srcOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001537 skip |=
1538 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_09c0013c, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001540 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1541 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001542 i, adj_extent.width, block_size.width, image_copy.srcOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001543 validation_error_map[VALIDATION_ERROR_09c0013c]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001544 }
1545
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001546 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
1547 if ((SafeModulo(adj_extent.height, block_size.height) != 0) &&
1548 (adj_extent.height + image_copy.srcOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001549 skip |=
1550 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001551 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c0013e, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001552 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1553 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001554 i, adj_extent.height, block_size.height, image_copy.srcOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001555 validation_error_map[VALIDATION_ERROR_09c0013e]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001556 }
1557
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001558 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton6f9059e2017-05-02 17:15:13 -06001559 uint32_t copy_depth = (slice_override ? depth_slices : image_copy.extent.depth);
1560 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + image_copy.srcOffset.z != mip_extent.depth)) {
1561 skip |=
1562 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001563 reinterpret_cast<const uint64_t &>(src_state->image), __LINE__, VALIDATION_ERROR_09c00140, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001564 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1565 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d). %s.",
1566 i, image_copy.extent.depth, block_size.depth, image_copy.srcOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001567 validation_error_map[VALIDATION_ERROR_09c00140]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001568 }
1569 } // Compressed
1570
1571 // Do all checks on dest image
1572 //
1573 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
1574 if ((0 != image_copy.dstOffset.y) || (1 != image_copy.extent.height)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001575 skip |=
1576 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1577 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00130, "IMAGE",
1578 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and extent.height is %d. For 1D images these must "
1579 "be 0 and 1, respectively. %s",
1580 i, image_copy.dstOffset.y, image_copy.extent.height, validation_error_map[VALIDATION_ERROR_09c00130]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001581 }
1582 }
1583
1584 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
1585 if ((0 != image_copy.dstOffset.z) || (1 != image_copy.extent.depth)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001586 skip |=
1587 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1588 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00134, "IMAGE",
1589 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D and 2D images "
1590 "these must be 0 and 1, respectively. %s",
1591 i, image_copy.dstOffset.z, image_copy.extent.depth, validation_error_map[VALIDATION_ERROR_09c00134]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001592 }
1593 }
1594
1595 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1596 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
1597 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 -06001598 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001599 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1600 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1601 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001602 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001603 }
1604 }
1605 // VU01199 changed with mnt1
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001606 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001607 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1608 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
1609 skip |=
1610 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001611 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001612 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
1613 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively. %s",
1614 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001615 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001616 }
1617 }
1618 } else { // Pre maint 1
1619 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
1620 if ((0 != image_copy.dstSubresource.baseArrayLayer) || (1 != image_copy.dstSubresource.layerCount)) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001621 skip |=
1622 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1623 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0011a, "IMAGE",
1624 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
1625 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
1626 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively. %s",
1627 i, image_copy.dstSubresource.baseArrayLayer, image_copy.dstSubresource.layerCount,
1628 validation_error_map[VALIDATION_ERROR_09c0011a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001629 }
1630 }
1631 }
1632
1633 // TODO: this VU is redundant with VU01224. Gitlab issue 812 submitted to get it removed from the spec.
1634 if ((image_copy.dstSubresource.baseArrayLayer >= dst_state->createInfo.arrayLayers) ||
1635 (image_copy.dstSubresource.baseArrayLayer + image_copy.dstSubresource.layerCount > dst_state->createInfo.arrayLayers)) {
1636 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 -06001637 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00136, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001638 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer (%d) must be less than the dest image's "
1639 "arrayLayers (%d), and the sum of baseArrayLayer and dstSubresource.layerCount (%d) must be less than "
1640 "or equal to the dest image's arrayLayers. %s",
1641 i, image_copy.dstSubresource.baseArrayLayer, dst_state->createInfo.arrayLayers,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001642 image_copy.dstSubresource.layerCount, validation_error_map[VALIDATION_ERROR_09c00136]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001643 }
1644
1645 // Checks that apply only to compressed images
1646 if (FormatIsCompressed(dst_state->createInfo.format)) {
1647 VkExtent3D block_size = FormatCompressedTexelBlockExtent(dst_state->createInfo.format);
1648
1649 // image offsets must be multiples of block dimensions
1650 if ((SafeModulo(image_copy.dstOffset.x, block_size.width) != 0) ||
1651 (SafeModulo(image_copy.dstOffset.y, block_size.height) != 0) ||
1652 (SafeModulo(image_copy.dstOffset.z, block_size.depth) != 0)) {
1653 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 -06001654 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00144, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001655 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
1656 "texel width & height (%d, %d). %s.",
1657 i, image_copy.dstOffset.x, image_copy.dstOffset.y, block_size.width, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001658 validation_error_map[VALIDATION_ERROR_09c00144]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001659 }
1660
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001661 // Extent width must be a multiple of block width, or extent+offset width must equal subresource width
1662 VkExtent3D adj_extent = image_copy.extent;
1663 if (!FormatIsCompressed(src_state->createInfo.format)) {
1664 // Copying from uncompressed source. Modify extent to be extent * texel block size
1665 adj_extent.width *= block_size.width;
1666 adj_extent.height *= block_size.height;
1667 }
1668
Dave Houlton6f9059e2017-05-02 17:15:13 -06001669 VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(image_copy.dstSubresource));
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001670 if ((SafeModulo(adj_extent.width, block_size.width) != 0) &&
1671 (adj_extent.width + image_copy.dstOffset.x != mip_extent.width)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001672 skip |=
1673 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_09c00146, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001675 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1676 "width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001677 i, adj_extent.width, block_size.width, image_copy.dstOffset.x, mip_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001678 validation_error_map[VALIDATION_ERROR_09c00146]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001679 }
1680
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001681 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
1682 if ((SafeModulo(adj_extent.height, block_size.height) != 0) &&
1683 (adj_extent.height + image_copy.dstOffset.y != mip_extent.height)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001684 skip |=
1685 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001686 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c00148, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001687 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
1688 "height (%d), or when added to dstOffset.y (%d) must equal the image subresource height (%d). %s.",
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001689 i, adj_extent.height, block_size.height, image_copy.dstOffset.y, mip_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001690 validation_error_map[VALIDATION_ERROR_09c00148]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001691 }
1692
Mark Lobodzinskid0788802017-10-19 15:38:59 -06001693 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton6f9059e2017-05-02 17:15:13 -06001694 uint32_t copy_depth = (slice_override ? depth_slices : image_copy.extent.depth);
1695 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + image_copy.dstOffset.z != mip_extent.depth)) {
1696 skip |=
1697 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001698 reinterpret_cast<const uint64_t &>(dst_state->image), __LINE__, VALIDATION_ERROR_09c0014a, "IMAGE",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001699 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
1700 "depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d). %s.",
1701 i, image_copy.extent.depth, block_size.depth, image_copy.dstOffset.z, mip_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001702 validation_error_map[VALIDATION_ERROR_09c0014a]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001703 }
1704 } // Compressed
1705 }
1706 return skip;
1707}
1708
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001709bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001710 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1711 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001712 bool skip = false;
1713 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001714 skip = ValidateImageCopyData(device_data, report_data, region_count, regions, src_image_state, dst_image_state);
1715
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001716 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1717
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001718 for (uint32_t i = 0; i < region_count; i++) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001719 bool slice_override = false;
1720 uint32_t depth_slices = 0;
1721
1722 // Special case for copying between a 1D/2D array and a 3D image
1723 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
1724 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
1725 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
1726 depth_slices = regions[i].dstSubresource.layerCount; // Slice count from 2D subresource
1727 slice_override = (depth_slices != 1);
1728 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
1729 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
1730 depth_slices = regions[i].srcSubresource.layerCount; // Slice count from 2D subresource
1731 slice_override = (depth_slices != 1);
1732 }
1733
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001734 if (regions[i].srcSubresource.layerCount == 0) {
1735 std::stringstream ss;
1736 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001737 skip |=
1738 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1739 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001740 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001741
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001742 if (regions[i].dstSubresource.layerCount == 0) {
1743 std::stringstream ss;
1744 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Petr Krausbc7f5442017-05-14 23:43:38 +02001745 skip |=
1746 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1747 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001748 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001749
Mark Lobodzinski28426ae2017-06-01 07:56:38 -06001750 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06001751 // No chance of mismatch if we're overriding depth slice count
1752 if (!slice_override) {
1753 // The number of depth slices in srcSubresource and dstSubresource must match
1754 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
1755 uint32_t src_slices =
1756 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? regions[i].extent.depth
1757 : regions[i].srcSubresource.layerCount);
1758 uint32_t dst_slices =
1759 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? regions[i].extent.depth
1760 : regions[i].dstSubresource.layerCount);
1761 if (src_slices != dst_slices) {
1762 std::stringstream ss;
1763 ss << "vkCmdCopyImage: number of depth slices in source and destination subresources for pRegions[" << i
1764 << "] do not match";
1765 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 -06001766 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE",
1767 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Dave Houlton6f9059e2017-05-02 17:15:13 -06001768 }
1769 }
1770 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001771 // For each region the layerCount member of srcSubresource and dstSubresource must match
1772 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1773 std::stringstream ss;
1774 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1775 << "] do not match";
1776 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001777 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00118, "IMAGE", "%s. %s",
1778 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c00118]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001779 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001780 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001781
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001782 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1783 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1784 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must 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 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00112, "IMAGE", "%s. %s", str,
1787 validation_error_map[VALIDATION_ERROR_09c00112]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001788 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001789
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001790 // For each region, the aspectMask member of srcSubresource must be present in the source image
1791 if (!VerifyAspectsPresent(regions[i].srcSubresource.aspectMask, src_image_state->createInfo.format)) {
1792 std::stringstream ss;
1793 ss << "vkCmdCopyImage: pRegion[" << i
1794 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1795 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 -06001796 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011c, "IMAGE", "%s. %s",
1797 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011c]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001798 }
1799
1800 // For each region, the aspectMask member of dstSubresource must be present in the destination image
1801 if (!VerifyAspectsPresent(regions[i].dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
1802 std::stringstream ss;
1803 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1804 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 -06001805 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0011e, "IMAGE", "%s. %s",
1806 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_09c0011e]);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001807 }
1808
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001809 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1810 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1811 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1812 std::stringstream ss;
1813 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1814 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001815 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600150, "IMAGE", "%s. %s",
1816 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600150]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001817 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001818
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001819 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1820 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1821 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1822 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1823 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
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_0a60014e, "IMAGE", "%s. %s", str,
1826 validation_error_map[VALIDATION_ERROR_0a60014e]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001827 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001828
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001829 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1830 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1831 std::stringstream ss;
1832 ss << "vkCmdCopyImage: pRegions[" << i
1833 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
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_0a600152, "IMAGE", "%s. %s",
1836 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001837 }
1838 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1839 std::stringstream ss;
1840 ss << "vkCmdCopyImage: pRegions[" << i
1841 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1842 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 -06001843 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600152, "IMAGE", "%s. %s",
1844 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600152]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001845 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001846
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001847 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1848 // image was created
1849 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1850 src_image_state->createInfo.arrayLayers) {
1851 std::stringstream ss;
1852 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1853 << "] baseArrayLayer + layerCount is "
1854 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1855 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 -06001856 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1857 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001858 }
1859 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1860 dst_image_state->createInfo.arrayLayers) {
1861 std::stringstream ss;
1862 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1863 << "] baseArrayLayer + layerCount is "
1864 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1865 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 -06001866 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_0a600154, "IMAGE", "%s. %s",
1867 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_0a600154]);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001868 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001869
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001870 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1871 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1872 // 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 -06001873 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(regions[i].srcSubresource));
1874 if (0 != ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001875 std::stringstream ss;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001876 ss << "vkCmdCopyImage: Source pRegion[" << i << "] with mipLevel [ " << regions[i].srcSubresource.mipLevel
1877 << " ], offset [ " << regions[i].srcOffset.x << ", " << regions[i].srcOffset.y << ", " << regions[i].srcOffset.z
1878 << " ], extent [ " << regions[i].extent.width << ", " << regions[i].extent.height << ", "
1879 << regions[i].extent.depth << " ] exceeds the source image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001880 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 -06001881 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f4, "IMAGE", "%s. %s",
1882 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f4]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001883 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001884
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001885 // 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 -06001886 img_extent = GetImageSubresourceExtent(dst_image_state, &(regions[i].dstSubresource));
1887 if (0 != ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001888 std::stringstream ss;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001889 ss << "vkCmdCopyImage: Dest pRegion[" << i << "] with mipLevel [ " << regions[i].dstSubresource.mipLevel
1890 << " ], offset [ " << regions[i].dstOffset.x << ", " << regions[i].dstOffset.y << ", " << regions[i].dstOffset.z
1891 << " ], extent [ " << regions[i].extent.width << ", " << regions[i].extent.height << ", "
1892 << regions[i].extent.depth << " ] exceeds the destination image dimensions";
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001893 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 -06001894 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f6, "IMAGE", "%s. %s",
1895 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f6]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001896 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001897 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001898
Dave Houltonfc1a4052017-04-27 14:32:45 -06001899 // Each dimension offset + extent limits must fall with image subresource extent
1900 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(regions[i].srcSubresource));
Dave Houlton6f9059e2017-05-02 17:15:13 -06001901 VkExtent3D copy_extent = regions[i].extent;
1902 if (slice_override) copy_extent.depth = depth_slices;
1903 uint32_t extent_check = ExceedsBounds(&(regions[i].srcOffset), &copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001904 if (extent_check & x_bit) {
1905 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 -06001906 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00120, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001907 "vkCmdCopyImage: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1908 "width [%1d]. %s",
1909 i, regions[i].srcOffset.x, regions[i].extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001910 validation_error_map[VALIDATION_ERROR_09c00120]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001911 }
1912
1913 if (extent_check & y_bit) {
1914 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 -06001915 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00122, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001916 "vkCmdCopyImage: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1917 "height [%1d]. %s",
1918 i, regions[i].srcOffset.y, regions[i].extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001919 validation_error_map[VALIDATION_ERROR_09c00122]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001920 }
1921 if (extent_check & z_bit) {
1922 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001923 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00126, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001924 "vkCmdCopyImage: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1925 "depth [%1d]. %s",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001926 i, regions[i].srcOffset.z, copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001927 validation_error_map[VALIDATION_ERROR_09c00126]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001928 }
1929
1930 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(regions[i].dstSubresource));
Dave Houlton6f9059e2017-05-02 17:15:13 -06001931 copy_extent = regions[i].extent;
1932 if (slice_override) copy_extent.depth = depth_slices;
1933 extent_check = ExceedsBounds(&(regions[i].dstOffset), &copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001934 if (extent_check & x_bit) {
1935 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 -06001936 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012c, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001937 "vkCmdCopyImage: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
1938 "width [%1d]. %s",
1939 i, regions[i].dstOffset.x, regions[i].extent.width, subresource_extent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001940 validation_error_map[VALIDATION_ERROR_09c0012c]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001941 }
1942 if (extent_check & y_bit) {
1943 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 -06001944 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c0012e, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001945 "vkCmdCopyImage: Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
1946 "height [%1d]. %s",
1947 i, regions[i].dstOffset.y, regions[i].extent.height, subresource_extent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001948 validation_error_map[VALIDATION_ERROR_09c0012e]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001949 }
1950 if (extent_check & z_bit) {
1951 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 -06001952 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_09c00132, "IMAGE",
Dave Houltonfc1a4052017-04-27 14:32:45 -06001953 "vkCmdCopyImage: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
1954 "depth [%1d]. %s",
Dave Houlton6f9059e2017-05-02 17:15:13 -06001955 i, regions[i].dstOffset.z, copy_extent.depth, subresource_extent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001956 validation_error_map[VALIDATION_ERROR_09c00132]);
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 }
1958
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001959 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1960 // must not overlap in memory
1961 if (src_image_state->image == dst_image_state->image) {
1962 for (uint32_t j = 0; j < region_count; j++) {
1963 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1964 std::stringstream ss;
1965 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1966 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 -06001967 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_190000f8, "IMAGE", "%s. %s",
1968 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_190000f8]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001969 }
1970 }
1971 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001972 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001973
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001974 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1975 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1976 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06001977 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001978 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1979 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02001980 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1981 HandleToUint64(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001982 }
1983 } else {
Dave Houlton1d2022c2017-03-29 11:43:58 -06001984 size_t srcSize = FormatSize(src_image_state->createInfo.format);
1985 size_t destSize = FormatSize(dst_image_state->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001986 if (srcSize != destSize) {
1987 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1988 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 -06001989 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_1900010e, "IMAGE", "%s. %s", str,
1990 validation_error_map[VALIDATION_ERROR_1900010e]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001991 }
1992 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001993
Dave Houlton33c22b72017-02-28 13:16:02 -07001994 // Source and dest image sample counts must match
1995 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
1996 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
1997 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 -06001998 HandleToUint64(command_buffer), __LINE__, VALIDATION_ERROR_19000110, "IMAGE", "%s %s", str,
1999 validation_error_map[VALIDATION_ERROR_19000110]);
Dave Houlton33c22b72017-02-28 13:16:02 -07002000 }
2001
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002002 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_190000fe);
2003 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_19000108);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002004 // Validate that SRC & DST images have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002005 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_190000fc,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002007 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_19000106,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002008 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002009 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002010 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_19002415);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002011 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002012 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_19000017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06002013 bool hit_error = false;
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002014 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002015 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002016 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_19000102, &hit_error);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002017 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002018 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_1900010c, &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002019 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
2020 &regions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002021 }
2022
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002023 return skip;
2024}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002025
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002026void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002027 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
2028 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
2029 // Make sure that all image slices are updated to correct layout
2030 for (uint32_t i = 0; i < region_count; ++i) {
2031 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
2032 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
2033 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 // Update bindings between images and cmd buffer
2035 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2036 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07002037 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002038 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002039 function = [=]() {
2040 SetImageMemoryValid(device_data, dst_image_state, true);
2041 return false;
2042 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002043 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002044}
2045
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002046// Returns true if sub_rect is entirely contained within rect
2047static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2048 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2049 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2050 return false;
2051 return true;
2052}
2053
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002054bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2055 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002056 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002057 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2058
2059 bool skip = false;
2060 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002061 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2062 VALIDATION_ERROR_18602415);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002063 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002064 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002065 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002066 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2067 // 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 -07002068 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2069 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002070 skip |=
2071 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 +02002072 HandleToUint64(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002073 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
2074 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2075 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002076 }
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002077 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_18600017);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002078 }
2079
2080 // Validate that attachment is in reference list of active subpass
2081 if (cb_node->activeRenderPass) {
2082 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2083 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002084 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002085
2086 for (uint32_t i = 0; i < attachmentCount; i++) {
2087 auto clear_desc = &pAttachments[i];
2088 VkImageView image_view = VK_NULL_HANDLE;
2089
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002090 if (0 == clear_desc->aspectMask) {
2091 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002092 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c03, "IMAGE", "%s",
2093 validation_error_map[VALIDATION_ERROR_01c00c03]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002094 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2095 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 -06002096 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00028, "IMAGE", "%s",
2097 validation_error_map[VALIDATION_ERROR_01c00028]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002098 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002099 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002100 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2101 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_1860001e, "DS",
2102 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
2103 clear_desc->colorAttachment, cb_node->activeSubpass,
2104 validation_error_map[VALIDATION_ERROR_1860001e]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002105 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
2106 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002107 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(commandBuffer), __LINE__,
2108 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002109 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
2110 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002111 } else {
2112 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002113 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002114 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002115 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2116 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2117 char const str[] =
2118 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
2119 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 -06002120 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00026, "IMAGE", str, i,
2121 validation_error_map[VALIDATION_ERROR_01c00026]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002122 }
2123 } else { // Must be depth and/or stencil
2124 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2125 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2126 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
2127 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 -06002128 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_01c00c01, "IMAGE", str, i,
2129 validation_error_map[VALIDATION_ERROR_01c00c01]);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002130 }
2131 if (!subpass_desc->pDepthStencilAttachment ||
2132 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2133 skip |= log_msg(
2134 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Petr Krausbc7f5442017-05-14 23:43:38 +02002135 HandleToUint64(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002136 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002137 } else {
2138 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
2139 }
2140 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002141 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07002142 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002143 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002144 // The rectangular region specified by a given element of pRects must be contained within the render area of
2145 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002146 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
2147 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
2148 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002149 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 -06002150 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600020, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002151 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2152 "the current render pass instance. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002153 j, validation_error_map[VALIDATION_ERROR_18600020]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002154 }
2155 // The layers specified by a given element of pRects must be contained within every attachment that
2156 // pAttachments refers to
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002157 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
Dave Houlton8e157032017-05-22 16:16:27 -06002158 if ((pRects[j].baseArrayLayer >= attachment_layer_count) ||
2159 (pRects[j].baseArrayLayer + pRects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002160 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002161 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 -06002162 HandleToUint64(commandBuffer), __LINE__, VALIDATION_ERROR_18600022, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002163 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
2164 "pAttachment[%d]. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002165 j, i, validation_error_map[VALIDATION_ERROR_18600022]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002166 }
2167 }
2168 }
2169 }
2170 }
2171 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002172}
2173
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002174bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002175 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002176 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002177 bool skip = false;
2178 if (cb_node && src_image_state && dst_image_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002179 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800200);
2180 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_1c800204);
2181 skip |=
2182 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_1c802415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002183 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002184 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_1c800017);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002185
2186 // For each region, the number of layers in the image subresource should not be zero
2187 // For each region, src and dest image aspect must be color only
2188 for (uint32_t i = 0; i < regionCount; i++) {
2189 if (pRegions[i].srcSubresource.layerCount == 0) {
2190 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002191 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 +02002192 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002193 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002194 if (pRegions[i].dstSubresource.layerCount == 0) {
2195 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002196 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 +02002197 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002198 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002199 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2200 skip |= log_msg(
2201 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002202 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200216, "IMAGE",
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002203 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002204 validation_error_map[VALIDATION_ERROR_0a200216]);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002205 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002206 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2207 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2208 char const str[] =
2209 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
2210 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 -06002211 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_0a200214, "IMAGE", "%s. %s", str,
2212 validation_error_map[VALIDATION_ERROR_0a200214]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002213 }
2214 }
2215
2216 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2217 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002218 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 +02002219 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002220 }
2221 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2222 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002223 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 +02002224 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002225 }
2226 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2227 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2228 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 -06002229 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800202, "IMAGE", "%s. %s", str,
2230 validation_error_map[VALIDATION_ERROR_1c800202]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002231 }
2232 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2233 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2234 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 -06002235 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_1c800206, "IMAGE", "%s. %s", str,
2236 validation_error_map[VALIDATION_ERROR_1c800206]);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002237 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002238 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002239 } else {
2240 assert(0);
2241 }
2242 return skip;
2243}
2244
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002245void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2246 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002247 // Update bindings between images and cmd buffer
2248 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2249 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2250
2251 std::function<bool()> function = [=]() {
2252 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
2253 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002254 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002255 function = [=]() {
2256 SetImageMemoryValid(device_data, dst_image_state, true);
2257 return false;
2258 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002259 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002260}
2261
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002262bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002263 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
2264 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2265
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002266 bool skip = false;
2267 if (cb_node && src_image_state && dst_image_state) {
2268 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002269 VALIDATION_ERROR_184001d2);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002270 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002271 VALIDATION_ERROR_184001d4);
2272 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001b8);
2273 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_184001c2);
2274 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2275 VALIDATION_ERROR_184001b6, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2276 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2277 VALIDATION_ERROR_184001c0, "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
2278 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_18402415);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002279 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002280 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_18400017);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002281 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002282
Dave Houlton33c2d252017-06-09 17:08:32 -06002283 VkFormat src_format = src_image_state->createInfo.format;
2284 VkFormat dst_format = dst_image_state->createInfo.format;
2285 VkImageType src_type = src_image_state->createInfo.imageType;
2286 VkImageType dst_type = dst_image_state->createInfo.imageType;
2287
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002288 VkFormatProperties props = GetFormatProperties(device_data, src_format);
Dave Houlton33c2d252017-06-09 17:08:32 -06002289 VkImageTiling tiling = src_image_state->createInfo.tiling;
2290 VkFormatFeatureFlags flags =
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002291 (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002292 if (VK_FORMAT_FEATURE_BLIT_SRC_BIT != (flags & VK_FORMAT_FEATURE_BLIT_SRC_BIT)) {
2293 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2294 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b4, "IMAGE",
2295 "vkCmdBlitImage: source image format %s does not support VK_FORMAT_FEATURE_BLIT_SRC_BIT feature. %s",
2296 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001b4]);
2297 }
2298
2299 if ((VK_FILTER_LINEAR == filter) &&
2300 (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT != (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT))) {
2301 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2302 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d6, "IMAGE",
2303 "vkCmdBlitImage: source image format %s does not support linear filtering. %s",
2304 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d6]);
2305 }
2306
2307 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG !=
2308 (flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG))) {
2309 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2310 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001d8, "IMAGE",
2311 "vkCmdBlitImage: source image format %s does not support cubic filtering. %s",
2312 string_VkFormat(src_format), validation_error_map[VALIDATION_ERROR_184001d8]);
2313 }
2314
2315 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2316 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2317 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001da, "IMAGE",
2318 "vkCmdBlitImage: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified. %s",
2319 validation_error_map[VALIDATION_ERROR_184001da]);
2320 }
2321
2322 props = GetFormatProperties(device_data, dst_format);
2323 tiling = dst_image_state->createInfo.tiling;
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06002324 flags = (tiling == VK_IMAGE_TILING_LINEAR ? props.linearTilingFeatures : props.optimalTilingFeatures);
Dave Houlton33c2d252017-06-09 17:08:32 -06002325 if (VK_FORMAT_FEATURE_BLIT_DST_BIT != (flags & VK_FORMAT_FEATURE_BLIT_DST_BIT)) {
2326 skip |=
2327 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2328 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001be, "IMAGE",
2329 "vkCmdBlitImage: destination image format %s does not support VK_FORMAT_FEATURE_BLIT_DST_BIT feature. %s",
2330 string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_184001be]);
2331 }
2332
2333 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2334 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2335 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2336 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001c8, "IMAGE",
2337 "vkCmdBlitImage: source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT. %s",
2338 validation_error_map[VALIDATION_ERROR_184001c8]);
2339 }
2340
2341 // Validate consistency for unsigned formats
2342 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2343 std::stringstream ss;
2344 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
2345 << "the other one must also have unsigned integer format. "
2346 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2347 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2348 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001cc, "IMAGE", "%s. %s",
2349 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001cc]);
2350 }
2351
2352 // Validate consistency for signed formats
2353 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2354 std::stringstream ss;
2355 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
2356 << "the other one must also have signed integer format. "
2357 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2358 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2359 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ca, "IMAGE", "%s. %s",
2360 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ca]);
2361 }
2362
2363 // Validate filter for Depth/Stencil formats
2364 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
2365 std::stringstream ss;
2366 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
2367 << "then filter must be VK_FILTER_NEAREST.";
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_184001d0, "IMAGE", "%s. %s",
2370 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001d0]);
2371 }
2372
2373 // Validate aspect bits and formats for depth/stencil images
2374 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2375 if (src_format != dst_format) {
2376 std::stringstream ss;
2377 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
2378 << "stencil, the other one must have exactly the same format. "
2379 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
2380 << string_VkFormat(dst_format);
2381 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2382 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ce, "IMAGE", "%s. %s",
2383 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_184001ce]);
2384 }
2385
2386#if 0 // TODO: Cannot find VU statements or spec language for these in CmdBlitImage. Verify or remove.
2387 for (uint32_t i = 0; i < regionCount; i++) {
2388 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
2389
2390 if (FormatIsDepthAndStencil(src_format)) {
2391 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2392 std::stringstream ss;
2393 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
2394 "VK_IMAGE_ASPECT_DEPTH_BIT "
2395 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
2396 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2397 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2398 "%s", ss.str().c_str());
2399 }
2400 }
2401 else if (FormatIsStencilOnly(src_format)) {
2402 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
2403 std::stringstream ss;
2404 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
2405 << "set in both the srcImage and dstImage";
2406 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2407 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2408 "%s", ss.str().c_str());
2409 }
2410 }
2411 else if (FormatIsDepthOnly(src_format)) {
2412 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
2413 std::stringstream ss;
2414 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
2415 << "set in both the srcImage and dstImage";
2416 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2417 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE",
2418 "%s", ss.str().c_str());
2419 }
2420 }
2421 }
2422#endif
2423 } // Depth or Stencil
2424
2425 // Do per-region checks
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002426 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton48989f32017-05-26 15:01:46 -06002427 VkImageBlit rgn = pRegions[i];
2428
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002429 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06002430 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
2431 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002432 std::stringstream ss;
2433 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
2434 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 +02002435 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2436 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002437 }
Dave Houlton48989f32017-05-26 15:01:46 -06002438 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
2439 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002440 std::stringstream ss;
2441 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
2442 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 +02002443 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE", "%s",
2444 ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002445 }
Dave Houlton48989f32017-05-26 15:01:46 -06002446 if (rgn.srcSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002447 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
2448 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 +02002449 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002450 }
Dave Houlton48989f32017-05-26 15:01:46 -06002451 if (rgn.dstSubresource.layerCount == 0) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002452 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
2453 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 +02002454 HandleToUint64(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002455 }
2456
2457 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06002458 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002459 skip |=
2460 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 -06002461 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001de, "IMAGE",
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002462 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002463 i, validation_error_map[VALIDATION_ERROR_09a001de]);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07002464 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002465
Dave Houlton48989f32017-05-26 15:01:46 -06002466 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002467 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 -06002468 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001dc, "IMAGE",
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002469 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002470 validation_error_map[VALIDATION_ERROR_09a001dc]);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07002471 }
Dave Houlton48989f32017-05-26 15:01:46 -06002472
Dave Houlton33c2d252017-06-09 17:08:32 -06002473 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
2474 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2475 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e2, "IMAGE",
2476 "vkCmdBlitImage: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
2477 "image format %s. %s",
2478 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format),
2479 validation_error_map[VALIDATION_ERROR_09a001e2]);
2480 }
2481
2482 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
2483 skip |= log_msg(
2484 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2485 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e4, "IMAGE",
2486 "vkCmdBlitImage: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s. %s",
2487 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format), validation_error_map[VALIDATION_ERROR_09a001e4]);
2488 }
2489
Dave Houlton48989f32017-05-26 15:01:46 -06002490 // Validate source image offsets
2491 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002492 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002493 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
2494 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2495 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ea, "IMAGE",
2496 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
2497 "of (%1d, %1d). These must be (0, 1). %s",
2498 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001ea]);
2499 }
2500 }
2501
Dave Houlton33c2d252017-06-09 17:08:32 -06002502 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002503 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
2504 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2505 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ee, "IMAGE",
2506 "vkCmdBlitImage: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2507 "srcOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2508 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001ee]);
2509 }
2510 }
2511
Dave Houlton33c2d252017-06-09 17:08:32 -06002512 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002513 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
2514 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002515 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002516 skip |= log_msg(
2517 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2518 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e6, "IMAGE",
2519 "vkCmdBlitImage: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d). %s", i,
2520 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width, validation_error_map[VALIDATION_ERROR_09a001e6]);
2521 }
2522 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
2523 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002524 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002525 skip |= log_msg(
2526 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2527 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e8, "IMAGE",
2528 "vkCmdBlitImage: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d). %s", i,
2529 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height, validation_error_map[VALIDATION_ERROR_09a001e8]);
2530 }
2531 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
2532 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002533 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002534 skip |= log_msg(
2535 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2536 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001ec, "IMAGE",
2537 "vkCmdBlitImage: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d). %s", i,
2538 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth, validation_error_map[VALIDATION_ERROR_09a001ec]);
2539 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002540 if (rgn.srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
2541 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2542 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2543 "vkCmdBlitImage: region [%d] source image, attempt to access a non-existant mip level %1d. %s", i,
2544 rgn.srcSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001ae]);
2545 } else if (oob) {
2546 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2547 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001ae, "IMAGE",
2548 "vkCmdBlitImage: region [%d] source image blit region exceeds image dimensions. %s", i,
2549 validation_error_map[VALIDATION_ERROR_184001ae]);
2550 }
Dave Houlton48989f32017-05-26 15:01:46 -06002551
2552 // Validate dest image offsets
2553 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06002554 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06002555 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
2556 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2557 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f4, "IMAGE",
2558 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
2559 "(%1d, %1d). These must be (0, 1). %s",
2560 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, validation_error_map[VALIDATION_ERROR_09a001f4]);
2561 }
2562 }
2563
Dave Houlton33c2d252017-06-09 17:08:32 -06002564 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06002565 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
2566 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2567 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f8, "IMAGE",
2568 "vkCmdBlitImage: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
2569 "dstOffset[].z values of (%1d, %1d). These must be (0, 1). %s",
2570 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, validation_error_map[VALIDATION_ERROR_09a001f8]);
2571 }
2572 }
2573
Dave Houlton33c2d252017-06-09 17:08:32 -06002574 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06002575 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
2576 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002577 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002578 skip |= log_msg(
2579 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2580 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f0, "IMAGE",
2581 "vkCmdBlitImage: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d). %s", i,
2582 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width, validation_error_map[VALIDATION_ERROR_09a001f0]);
2583 }
2584 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
2585 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002586 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002587 skip |= log_msg(
2588 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2589 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f2, "IMAGE",
2590 "vkCmdBlitImage: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d). %s", i,
2591 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height, validation_error_map[VALIDATION_ERROR_09a001f2]);
2592 }
2593 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
2594 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06002595 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06002596 skip |= log_msg(
2597 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2598 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001f6, "IMAGE",
2599 "vkCmdBlitImage: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d). %s", i,
2600 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth, validation_error_map[VALIDATION_ERROR_09a001f6]);
2601 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002602 if (rgn.dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002603 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 -06002604 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2605 "vkCmdBlitImage: region [%d] destination image, attempt to access a non-existant mip level %1d. %s",
2606 i, rgn.dstSubresource.mipLevel, validation_error_map[VALIDATION_ERROR_184001b0]);
2607 } else if (oob) {
2608 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2609 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_184001b0, "IMAGE",
2610 "vkCmdBlitImage: region [%d] destination image blit region exceeds image dimensions. %s", i,
2611 validation_error_map[VALIDATION_ERROR_184001b0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002612 }
2613
Dave Houlton33c2d252017-06-09 17:08:32 -06002614 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
2615 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
2616 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
2617 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2618 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_09a001e0, "IMAGE",
2619 "vkCmdBlitImage: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
2620 "layerCount other than 1. %s",
2621 i, validation_error_map[VALIDATION_ERROR_09a001e0]);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002622 }
2623 }
Dave Houlton33c2d252017-06-09 17:08:32 -06002624 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002625 } else {
2626 assert(0);
2627 }
2628 return skip;
2629}
2630
Tobin Ehlis58c884f2017-02-08 12:15:27 -07002631void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
2632 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002633 // Update bindings between images and cmd buffer
2634 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2635 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
2636
2637 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002638 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002639 function = [=]() {
2640 SetImageMemoryValid(device_data, dst_image_state, true);
2641 return false;
2642 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06002643 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002644}
2645
Tony Barbourdf013b92017-01-25 12:53:48 -07002646// This validates that the initial layout specified in the command buffer for
2647// the IMAGE is the same
2648// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07002649bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002650 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const & globalImageLayoutMap,
2651 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> & overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002652 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07002653 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002654 for (auto cb_image_data : pCB->imageLayoutMap) {
2655 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07002656
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002657 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
2658 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002659 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
2660 // TODO: Set memory invalid which is in mem_tracker currently
2661 } else if (imageLayout != cb_image_data.second.initialLayout) {
2662 if (cb_image_data.first.hasSubresource) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002663 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2664 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2665 "Cannot submit cmd buffer using image (0x%" PRIx64
2666 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
2667 "with layout %s when first use is %s.",
2668 HandleToUint64(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
2669 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
2670 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002671 } else {
Petr Krausbc7f5442017-05-14 23:43:38 +02002672 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2673 HandleToUint64(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2674 "Cannot submit cmd buffer using image (0x%" PRIx64
2675 ") with layout %s when "
2676 "first use is %s.",
2677 HandleToUint64(cb_image_data.first.image), string_VkImageLayout(imageLayout),
2678 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002679 }
2680 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07002681 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002682 }
2683 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07002684 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07002685}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002686
Tony Barbourdf013b92017-01-25 12:53:48 -07002687void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
2688 for (auto cb_image_data : pCB->imageLayoutMap) {
2689 VkImageLayout imageLayout;
2690 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
2691 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
2692 }
2693}
2694
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002695// Print readable FlagBits in FlagMask
2696static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
2697 std::string result;
2698 std::string separator;
2699
2700 if (accessMask == 0) {
2701 result = "[None]";
2702 } else {
2703 result = "[";
2704 for (auto i = 0; i < 32; i++) {
2705 if (accessMask & (1 << i)) {
2706 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
2707 separator = " | ";
2708 }
2709 }
2710 result = result + "]";
2711 }
2712 return result;
2713}
2714
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002715// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2716// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002717// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002718static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2719 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2720 const char *type) {
2721 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2722 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002723
2724 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2725 if (accessMask & ~(required_bit | optional_bits)) {
2726 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002727 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 +02002728 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002729 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2730 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002731 }
2732 } else {
2733 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002734 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 +02002735 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002736 "%s AccessMask %d %s must contain at least one of access bits %d "
2737 "%s when layout is %s, unless the app has previously added a "
2738 "barrier for this transition.",
2739 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2740 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002741 } else {
2742 std::string opt_bits;
2743 if (optional_bits != 0) {
2744 std::stringstream ss;
2745 ss << optional_bits;
2746 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2747 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002748 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 +02002749 HandleToUint64(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002750 "%s AccessMask %d %s must have required access bit %d %s %s when "
2751 "layout is %s, unless the app has previously added a barrier for "
2752 "this transition.",
2753 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2754 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002755 }
2756 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002757 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002758}
2759
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002760// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002761// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2762// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002763bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002764 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2765 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002766 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2767 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2768 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2769 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinskieb9e73f2017-04-13 10:06:48 -06002770 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 -06002771 VALIDATION_ERROR_12200688, "DS", "Cannot clear attachment %d with invalid first layout %s. %s",
2772 attachment, string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_12200688]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002773 }
2774 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002775 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002776}
2777
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002778bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2779 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002780 bool skip = false;
2781
2782 // Track when we're observing the first use of an attachment
2783 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2784 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2785 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07002786
2787 // Check input attachments first, so we can detect first-use-as-input for VU #00349
2788 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2789 auto attach_index = subpass.pInputAttachments[j].attachment;
2790 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2791
2792 switch (subpass.pInputAttachments[j].layout) {
2793 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2794 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2795 // These are ideal.
2796 break;
2797
2798 case VK_IMAGE_LAYOUT_GENERAL:
2799 // May not be optimal. TODO: reconsider this warning based on other constraints.
2800 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2801 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2802 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2803 break;
2804
2805 default:
2806 // No other layouts are acceptable
2807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2808 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2809 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2810 string_VkImageLayout(subpass.pInputAttachments[j].layout));
2811 }
2812
2813 VkImageLayout layout = subpass.pInputAttachments[j].layout;
2814 bool found_layout_mismatch = subpass.pDepthStencilAttachment &&
2815 subpass.pDepthStencilAttachment->attachment == attach_index &&
2816 subpass.pDepthStencilAttachment->layout != layout;
2817 for (uint32_t c = 0; !found_layout_mismatch && c < subpass.colorAttachmentCount; ++c) {
2818 found_layout_mismatch =
2819 (subpass.pColorAttachments[c].attachment == attach_index && subpass.pColorAttachments[c].layout != layout);
2820 }
2821 if (found_layout_mismatch) {
2822 skip |= log_msg(
2823 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002824 VALIDATION_ERROR_140006ae, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002825 "CreateRenderPass: Subpass %u pInputAttachments[%u] (%u) has layout %u, but is also used as a depth/color "
2826 "attachment with a different layout. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002827 i, j, attach_index, layout, validation_error_map[VALIDATION_ERROR_140006ae]);
Cort Stratton7547f772017-05-04 15:18:52 -07002828 }
2829
2830 if (attach_first_use[attach_index]) {
2831 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2832 pCreateInfo->pAttachments[attach_index]);
2833
2834 bool used_as_depth =
2835 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
2836 bool used_as_color = false;
2837 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
2838 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
2839 }
2840 if (!used_as_depth && !used_as_color &&
2841 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2842 skip |= log_msg(
2843 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002844 VALIDATION_ERROR_1400069c, "DS",
Cort Stratton7547f772017-05-04 15:18:52 -07002845 "CreateRenderPass: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002846 attach_index, attach_index, validation_error_map[VALIDATION_ERROR_1400069c]);
Cort Stratton7547f772017-05-04 15:18:52 -07002847 }
2848 }
2849 attach_first_use[attach_index] = false;
2850 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002851 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2852 auto attach_index = subpass.pColorAttachments[j].attachment;
2853 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2854
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002855 // TODO: Need a way to validate shared presentable images here, currently just allowing
2856 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
2857 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002858 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002859 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06002860 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002861 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
2862 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002863 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002864
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002865 case VK_IMAGE_LAYOUT_GENERAL:
2866 // May not be optimal; TODO: reconsider this warning based on other constraints?
2867 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2868 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2869 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2870 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002871
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002872 default:
2873 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2874 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2875 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2876 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002877 }
2878
2879 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002880 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2881 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002882 }
2883 attach_first_use[attach_index] = false;
2884 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06002885
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002886 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2887 switch (subpass.pDepthStencilAttachment->layout) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06002888 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2889 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2890 // These are ideal.
2891 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002892
Lenny Komowb79f04a2017-09-18 17:07:00 -06002893 case VK_IMAGE_LAYOUT_GENERAL:
2894 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2895 // doing a bunch of transitions.
2896 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2897 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2898 "GENERAL layout for depth attachment may not give optimal performance.");
2899 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002900
Lenny Komowb79f04a2017-09-18 17:07:00 -06002901 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
2902 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
2903 if (GetDeviceExtensions(device_data)->vk_khr_maintenance2) {
2904 break;
2905 } else {
2906 // Intentionally fall through to generic error message
2907 }
2908
2909 default:
2910 // No other layouts are acceptable
2911 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2912 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2913 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2914 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2915 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002916 }
2917
2918 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2919 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002920 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2921 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002922 }
2923 attach_first_use[attach_index] = false;
2924 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002925 }
2926 return skip;
2927}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002928
2929// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002930bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2931 VkDeviceSize offset, VkDeviceSize end_offset) {
2932 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2933 bool skip = false;
2934 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2935 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002936 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2937 for (auto image_handle : mem_info->bound_images) {
2938 auto img_it = mem_info->bound_ranges.find(image_handle);
2939 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002940 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002941 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002942 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002943 for (auto layout : layouts) {
2944 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002945 skip |=
2946 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
2947 HandleToUint64(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2948 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2949 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
2950 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002951 }
2952 }
2953 }
2954 }
2955 }
2956 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002957 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002958}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002959
2960// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2961// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002962static 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 -06002963 VulkanObjectType obj_type, int32_t const msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002964 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002965
2966 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002967 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06002968 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07002969 if (strict) {
2970 correct_usage = ((actual & desired) == desired);
2971 } else {
2972 correct_usage = ((actual & desired) != 0);
2973 }
2974 if (!correct_usage) {
2975 if (msgCode == -1) {
2976 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06002977 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 -06002978 MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2979 "Invalid usage flag for %s 0x%" PRIxLEAST64
2980 " used by %s. In this case, %s should have %s set during creation.",
2981 type_str, obj_handle, func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002982 } else {
2983 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski33826372017-04-13 11:10:11 -06002984 skip = log_msg(
Mark Lobodzinskic51dbb72017-04-13 14:25:39 -06002985 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 -06002986 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation. %s",
2987 type_str, obj_handle, func_name, type_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002988 }
2989 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002990 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002991}
2992
2993// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2994// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07002995bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002996 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002997 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
2998 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002999}
3000
3001// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3002// where an error will be flagged if usage is not correct
Chris Forbes8fdba302017-04-24 18:34:28 -07003003bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, bool strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07003004 int32_t const msgCode, char const *func_name, char const *usage_string) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003005 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3006 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003007}
3008
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003009bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003010 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003011 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3012
Chris Forbese0f511c2017-06-14 12:38:01 -07003013 // TODO: Add check for VALIDATION_ERROR_1ec0071e (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003014
3015 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
3016 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 -06003017 VALIDATION_ERROR_01400726, "DS",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003018 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
3019 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003020 validation_error_map[VALIDATION_ERROR_01400726]);
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003021 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003022
3023 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
3024 skip |=
3025 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 -07003026 VALIDATION_ERROR_01400728, "DS",
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003027 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003028 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set. %s",
3029 validation_error_map[VALIDATION_ERROR_01400728]);
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003030 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003031
3032 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
3033 skip |=
3034 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 -07003035 VALIDATION_ERROR_0140072a, "DS",
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003036 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
Chris Forbese0f511c2017-06-14 12:38:01 -07003037 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set. %s",
3038 validation_error_map[VALIDATION_ERROR_0140072a]);
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003039 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07003040 return skip;
3041}
3042
3043void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
3044 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3045 GetBufferMap(device_data)
3046 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3047}
3048
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003049bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
3050 bool skip = false;
3051 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003052 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3053 if (buffer_state) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003054 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_01a0074e);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003055 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3056 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003057 skip |= ValidateBufferUsageFlags(
3058 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 -06003059 VALIDATION_ERROR_01a00748, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003060 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003061 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003062}
3063
3064void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
3065 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3066}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003067
3068// For the given format verify that the aspect masks make sense
3069bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
3070 const char *func_name) {
3071 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3072 bool skip = false;
Dave Houlton1d2022c2017-03-29 11:43:58 -06003073 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003074 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003075 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 -06003076 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003077 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003078 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003079 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003080 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 -06003081 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003082 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003083 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003084 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003085 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003086 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003087 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 -06003088 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003089 "%s: Depth/stencil image formats must have "
3090 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
3091 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003092 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003093 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003095 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003096 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
3097 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003098 func_name, validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003099 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003100 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003101 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003102 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 -06003103 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003104 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003105 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003106 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003107 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 -06003108 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003109 "%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 -06003110 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003111 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003112 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003113 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003114 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 -06003115 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003116 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003117 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003118 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003119 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 -06003120 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mark Lobodzinski602de982017-02-09 11:01:33 -07003121 "%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 -06003122 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003123 }
3124 }
3125 return skip;
3126}
3127
Petr Krausffa94af2017-08-08 21:46:02 +02003128struct SubresourceRangeErrorCodes {
3129 UNIQUE_VALIDATION_ERROR_CODE base_mip_err, mip_count_err, base_layer_err, layer_count_err;
3130};
3131
3132bool ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count, const uint32_t image_layer_count,
3133 const VkImageSubresourceRange &subresourceRange, const char *cmd_name, const char *param_name,
3134 const char *image_layer_count_var_name, const uint64_t image_handle,
3135 SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003136 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3137 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003138
3139 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003140 if (subresourceRange.baseMipLevel >= image_mip_count) {
3141 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3142 errorCodes.base_mip_err, "IMAGE",
3143 "%s: %s.baseMipLevel (= %" PRIu32
3144 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 "). %s",
3145 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count,
3146 validation_error_map[errorCodes.base_mip_err]);
3147 }
Petr Kraus4d718682017-05-18 03:38:41 +02003148
Petr Krausffa94af2017-08-08 21:46:02 +02003149 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3150 if (subresourceRange.levelCount == 0) {
3151 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3152 __LINE__, errorCodes.mip_count_err, "IMAGE", "%s: %s.levelCount is 0. %s", cmd_name, param_name,
3153 validation_error_map[errorCodes.mip_count_err]);
3154 } else {
3155 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003156
Petr Krausffa94af2017-08-08 21:46:02 +02003157 if (necessary_mip_count > image_mip_count) {
3158 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3159 __LINE__, errorCodes.mip_count_err, "IMAGE",
3160 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3161 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 "). %s",
3162 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
3163 necessary_mip_count, image_mip_count, validation_error_map[errorCodes.mip_count_err]);
3164 }
Petr Kraus4d718682017-05-18 03:38:41 +02003165 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003166 }
Petr Kraus4d718682017-05-18 03:38:41 +02003167
3168 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003169 if (subresourceRange.baseArrayLayer >= image_layer_count) {
3170 skip |=
3171 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle, __LINE__,
3172 errorCodes.base_layer_err, "IMAGE",
3173 "%s: %s.baseArrayLayer (= %" PRIu32
3174 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 "). %s",
3175 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count,
3176 validation_error_map[errorCodes.base_layer_err]);
3177 }
Petr Kraus4d718682017-05-18 03:38:41 +02003178
Petr Krausffa94af2017-08-08 21:46:02 +02003179 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3180 if (subresourceRange.layerCount == 0) {
3181 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3182 __LINE__, errorCodes.layer_count_err, "IMAGE", "%s: %s.layerCount is 0. %s", cmd_name, param_name,
3183 validation_error_map[errorCodes.layer_count_err]);
3184 } else {
3185 const uint64_t necessary_layer_count =
3186 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003187
Petr Krausffa94af2017-08-08 21:46:02 +02003188 if (necessary_layer_count > image_layer_count) {
3189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
3190 __LINE__, errorCodes.layer_count_err, "IMAGE",
3191 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
3192 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 "). %s",
3193 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
3194 necessary_layer_count, image_layer_count_var_name, image_layer_count,
3195 validation_error_map[errorCodes.layer_count_err]);
3196 }
Petr Kraus4d718682017-05-18 03:38:41 +02003197 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003198 }
Petr Kraus4d718682017-05-18 03:38:41 +02003199
Mark Lobodzinski602de982017-02-09 11:01:33 -07003200 return skip;
3201}
3202
Petr Krausffa94af2017-08-08 21:46:02 +02003203bool ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3204 bool is_imageview_2d_type, const VkImageSubresourceRange &subresourceRange) {
3205 bool is_khr_maintenance1 = GetDeviceExtensions(device_data)->vk_khr_maintenance1;
3206 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
3207 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
3208 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
3209
3210 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
3211 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
3212
3213 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3214 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0ac00b8c;
3215 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0ac00b8e;
3216 subresourceRangeErrorCodes.base_layer_err =
3217 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b98 : VALIDATION_ERROR_0ac00b94) : VALIDATION_ERROR_0ac00b90;
3218 subresourceRangeErrorCodes.layer_count_err =
3219 is_khr_maintenance1 ? (is_3D_to_2D_map ? VALIDATION_ERROR_0ac00b9a : VALIDATION_ERROR_0ac00b96) : VALIDATION_ERROR_0ac00b92;
3220
3221 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
3222 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
3223 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3224}
3225
3226bool ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3227 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3228 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3229 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18800b7c;
3230 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18800b7e;
3231 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18800b80;
3232 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18800b82;
3233
3234 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3235 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
3236 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3237}
3238
3239bool ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3240 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
3241 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3242 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_18a00b84;
3243 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_18a00b86;
3244 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_18a00b88;
3245 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_18a00b8a;
3246
3247 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3248 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
3249 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
3250}
3251
3252bool ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
3253 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3254 const char *param_name) {
3255 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
3256 subresourceRangeErrorCodes.base_mip_err = VALIDATION_ERROR_0a000b9c;
3257 subresourceRangeErrorCodes.mip_count_err = VALIDATION_ERROR_0a000b9e;
3258 subresourceRangeErrorCodes.base_layer_err = VALIDATION_ERROR_0a000ba0;
3259 subresourceRangeErrorCodes.layer_count_err = VALIDATION_ERROR_0a000ba2;
3260
3261 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
3262 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
3263 subresourceRangeErrorCodes);
3264}
3265
Mark Lobodzinski602de982017-02-09 11:01:33 -07003266bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
3267 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3268 bool skip = false;
3269 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
3270 if (image_state) {
3271 skip |= ValidateImageUsageFlags(
3272 device_data, image_state,
3273 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06003274 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003275 false, -1, "vkCreateImageView()",
3276 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
3277 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003278 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_0ac007f8);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003279 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02003280 skip |= ValidateCreateImageViewSubresourceRange(
3281 device_data, image_state,
3282 create_info->viewType == VK_IMAGE_VIEW_TYPE_2D || create_info->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
3283 create_info->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003284
3285 VkImageCreateFlags image_flags = image_state->createInfo.flags;
3286 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003287 VkImageUsageFlags image_usage = image_state->createInfo.usage;
3288 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003289 VkFormat view_format = create_info->format;
3290 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06003291 VkImageType image_type = image_state->createInfo.imageType;
3292 VkImageViewType view_type = create_info->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07003293
3294 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
3295 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06003296 if ((!GetDeviceExtensions(device_data)->vk_khr_maintenance2 ||
3297 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
3298 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
3299 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
3300 std::stringstream ss;
3301 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
3302 << " is not in the same format compatibility class as image (" << HandleToUint64(create_info->image)
3303 << ") format " << string_VkFormat(image_format)
3304 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
3305 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
3306 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3307 __LINE__, VALIDATION_ERROR_0ac007f4, "IMAGE", "%s %s", ss.str().c_str(),
3308 validation_error_map[VALIDATION_ERROR_0ac007f4]);
3309 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003310 }
3311 } else {
3312 // Format MUST be IDENTICAL to the format the image was created with
3313 if (image_format != view_format) {
3314 std::stringstream ss;
3315 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Petr Krausbc7f5442017-05-14 23:43:38 +02003316 << HandleToUint64(create_info->image) << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07003317 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003318 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 -06003319 VALIDATION_ERROR_0ac007f6, "IMAGE", "%s %s", ss.str().c_str(),
3320 validation_error_map[VALIDATION_ERROR_0ac007f6]);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003321 }
3322 }
3323
3324 // Validate correct image aspect bits for desired formats and format consistency
3325 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06003326
3327 switch (image_type) {
3328 case VK_IMAGE_TYPE_1D:
3329 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
3330 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3331 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3332 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3333 string_VkImageViewType(view_type), string_VkImageType(image_type),
3334 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3335 }
3336 break;
3337 case VK_IMAGE_TYPE_2D:
3338 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
3339 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
3340 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
3341 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3342 __LINE__, VALIDATION_ERROR_0ac007d6, "IMAGE",
3343 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3344 string_VkImageViewType(view_type), string_VkImageType(image_type),
3345 validation_error_map[VALIDATION_ERROR_0ac007d6]);
3346 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
3347 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3348 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3349 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3350 string_VkImageViewType(view_type), string_VkImageType(image_type),
3351 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3352 }
3353 }
3354 break;
3355 case VK_IMAGE_TYPE_3D:
3356 if (GetDeviceExtensions(device_data)->vk_khr_maintenance1) {
3357 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3358 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
3359 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
3360 skip |= log_msg(
3361 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3362 __LINE__, VALIDATION_ERROR_0ac007da, "IMAGE",
3363 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3364 string_VkImageViewType(view_type), string_VkImageType(image_type),
3365 validation_error_map[VALIDATION_ERROR_0ac007da]);
3366 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
3367 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
3368 skip |= log_msg(
3369 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3370 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3371 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s when the "
3372 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
3373 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled. %s",
3374 string_VkImageViewType(view_type), string_VkImageType(image_type),
3375 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3376 }
3377 } else {
3378 skip |=
3379 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3380 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3381 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3382 string_VkImageViewType(view_type), string_VkImageType(image_type),
3383 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3384 }
3385 }
3386 } else {
3387 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
3388 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3389 __LINE__, VALIDATION_ERROR_0ac007fa, "IMAGE",
3390 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s. %s",
3391 string_VkImageViewType(view_type), string_VkImageType(image_type),
3392 validation_error_map[VALIDATION_ERROR_0ac007fa]);
3393 }
3394 }
3395 break;
3396 default:
3397 break;
3398 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003399
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003400 VkFormatProperties format_properties = GetFormatProperties(device_data, view_format);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003401 bool check_tiling_features = false;
3402 VkFormatFeatureFlags tiling_features = 0;
3403 UNIQUE_VALIDATION_ERROR_CODE linear_error_codes[] = {
3404 VALIDATION_ERROR_0ac007dc, VALIDATION_ERROR_0ac007e0, VALIDATION_ERROR_0ac007e2,
3405 VALIDATION_ERROR_0ac007e4, VALIDATION_ERROR_0ac007e6,
3406 };
3407 UNIQUE_VALIDATION_ERROR_CODE optimal_error_codes[] = {
3408 VALIDATION_ERROR_0ac007e8, VALIDATION_ERROR_0ac007ea, VALIDATION_ERROR_0ac007ec,
3409 VALIDATION_ERROR_0ac007ee, VALIDATION_ERROR_0ac007f0,
3410 };
3411 UNIQUE_VALIDATION_ERROR_CODE *error_codes = nullptr;
3412 if (image_tiling == VK_IMAGE_TILING_LINEAR) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003413 tiling_features = format_properties.linearTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003414 error_codes = linear_error_codes;
3415 check_tiling_features = true;
3416 } else if (image_tiling == VK_IMAGE_TILING_OPTIMAL) {
Jeremy Kniager7ec550f2017-08-16 14:57:42 -06003417 tiling_features = format_properties.optimalTilingFeatures;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06003418 error_codes = optimal_error_codes;
3419 check_tiling_features = true;
3420 }
3421
3422 if (check_tiling_features) {
3423 if (tiling_features == 0) {
3424 skip |=
3425 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3426 error_codes[0], "IMAGE",
3427 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3428 "%s flag set. %s",
3429 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[0]]);
3430 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
3431 skip |=
3432 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3433 error_codes[1], "IMAGE",
3434 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3435 "%s and VK_IMAGE_USAGE_SAMPLED_BIT flags set. %s",
3436 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[1]]);
3437 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
3438 skip |=
3439 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3440 error_codes[2], "IMAGE",
3441 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3442 "%s and VK_IMAGE_USAGE_STORAGE_BIT flags set. %s",
3443 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[2]]);
3444 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
3445 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
3446 skip |=
3447 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3448 error_codes[3], "IMAGE",
3449 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3450 "%s and VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT flags set. %s",
3451 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[3]]);
3452 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
3453 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
3454 skip |=
3455 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3456 error_codes[4], "IMAGE",
3457 "vkCreateImageView() pCreateInfo->format %s cannot be used with an image having the "
3458 "%s and VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT flags set. %s",
3459 string_VkFormat(view_format), string_VkImageTiling(image_tiling), validation_error_map[error_codes[4]]);
3460 }
3461 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003462 }
3463 return skip;
3464}
3465
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07003466void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
3467 auto image_view_map = GetImageViewMap(device_data);
3468 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
3469
3470 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003471 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06003472 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
3473 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003474}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003475
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003476bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3477 BUFFER_STATE *dst_buffer_state) {
3478 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003479 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000ee);
3480 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c000f2);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003481 // Validate that SRC & DST buffers have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003482 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
3483 VALIDATION_ERROR_18c000ec, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3484 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3485 VALIDATION_ERROR_18c000f0, "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07003486 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003487 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_18c02415);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003488 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003489 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_18c00017);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003490 return skip;
3491}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003492
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003493void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
3494 BUFFER_STATE *dst_buffer_state) {
3495 // Update bindings between buffers and cmd buffer
3496 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
3497 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
3498
3499 std::function<bool()> function = [=]() {
3500 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
3501 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003502 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003503 function = [=]() {
3504 SetBufferMemoryValid(device_data, dst_buffer_state, true);
3505 return false;
3506 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003507 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07003508}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003509
3510static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
3511 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3512 bool skip = false;
3513 auto buffer_state = GetBufferState(device_data, buffer);
3514 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003515 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 -07003516 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
Petr Krausbc7f5442017-05-14 23:43:38 +02003517 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", HandleToUint64(buffer));
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003518 } else {
3519 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003520 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 -06003521 HandleToUint64(buffer), __LINE__, VALIDATION_ERROR_23c00734, "DS",
Petr Krausbc7f5442017-05-14 23:43:38 +02003522 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", HandleToUint64(buffer),
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003523 validation_error_map[VALIDATION_ERROR_23c00734]);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003524 }
3525 }
3526 return skip;
3527}
3528
3529bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
3530 VK_OBJECT *obj_struct) {
3531 *image_view_state = GetImageViewState(device_data, image_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003532 *obj_struct = {HandleToUint64(image_view), kVulkanObjectTypeImageView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003533 if (GetDisables(device_data)->destroy_image_view) return false;
3534 bool skip = false;
3535 if (*image_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003536 skip |=
3537 ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, "vkDestroyImageView", VALIDATION_ERROR_25400804);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003538 }
3539 return skip;
3540}
3541
3542void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
3543 VK_OBJECT obj_struct) {
3544 // Any bound cmd buffers are now invalid
3545 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
3546 (*GetImageViewMap(device_data)).erase(image_view);
3547}
3548
3549bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
3550 *buffer_state = GetBufferState(device_data, buffer);
Petr Krausbc7f5442017-05-14 23:43:38 +02003551 *obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003552 if (GetDisables(device_data)->destroy_buffer) return false;
3553 bool skip = false;
3554 if (*buffer_state) {
3555 skip |= validateIdleBuffer(device_data, buffer);
3556 }
3557 return skip;
3558}
3559
3560void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
3561 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
3562 for (auto mem_binding : buffer_state->GetBoundMemory()) {
3563 auto mem_info = GetMemObjInfo(device_data, mem_binding);
3564 if (mem_info) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003565 core_validation::RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003566 }
3567 }
Petr Krausbc7f5442017-05-14 23:43:38 +02003568 ClearMemoryObjectBindings(device_data, HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003569 GetBufferMap(device_data)->erase(buffer_state->buffer);
3570}
3571
3572bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
3573 VK_OBJECT *obj_struct) {
3574 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
Petr Krausbc7f5442017-05-14 23:43:38 +02003575 *obj_struct = {HandleToUint64(buffer_view), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003576 if (GetDisables(device_data)->destroy_buffer_view) return false;
3577 bool skip = false;
3578 if (*buffer_view_state) {
Mike Schuchardta5025652017-09-27 14:56:21 -06003579 skip |=
3580 ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, "vkDestroyBufferView", VALIDATION_ERROR_23e00750);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07003581 }
3582 return skip;
3583}
3584
3585void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
3586 VK_OBJECT obj_struct) {
3587 // Any bound cmd buffers are now invalid
3588 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
3589 GetBufferViewMap(device_data)->erase(buffer_view);
3590}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003591
3592bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3593 bool skip = false;
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003594 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_1b40003e);
Mike Schuchardt9c582402017-02-23 15:57:37 -07003595 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003596 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_1b402415);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003597 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
3598 // Validate that DST buffer has correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003599 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_1b40003a,
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003600 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003601 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_1b400017);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003602 return skip;
3603}
3604
3605void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
3606 std::function<bool()> function = [=]() {
3607 SetBufferMemoryValid(device_data, buffer_state, true);
3608 return false;
3609 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003610 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003611 // Update bindings between buffer and cmd buffer
3612 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07003613}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003614
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003615bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
3616 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003617 bool skip = false;
3618
3619 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003620 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
3621 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003622 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 -06003623 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160018e, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003624 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
3625 "must be 0 and 1, respectively. %s",
3626 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003627 validation_error_map[VALIDATION_ERROR_0160018e]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003628 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003629 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003630
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003631 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
3632 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003633 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 -06003634 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600192, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003635 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
3636 "must be 0 and 1, respectively. %s",
3637 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003638 validation_error_map[VALIDATION_ERROR_01600192]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003639 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003640 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003641
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003642 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
3643 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
3644 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 -06003645 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001aa, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003646 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
3647 "%d. For 3D images these must be 0 and 1, respectively. %s",
3648 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003649 validation_error_map[VALIDATION_ERROR_016001aa]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003650 }
3651 }
3652
3653 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
3654 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Dave Houlton1d2022c2017-03-29 11:43:58 -06003655 auto texel_size = FormatSize(image_state->createInfo.format);
Dave Houlton1150cf52017-04-27 14:38:11 -06003656 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, texel_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003657 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003658 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600182, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003659 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
3660 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003661 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01600182]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003662 }
3663
3664 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06003665 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003666 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 -06003667 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600184, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003668 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003669 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01600184]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003670 }
3671
3672 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
3673 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
3674 skip |= log_msg(
3675 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003676 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600186, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003677 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
3678 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003679 validation_error_map[VALIDATION_ERROR_01600186]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003680 }
3681
3682 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
3683 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
3684 skip |= log_msg(
3685 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003686 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600188, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003687 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
3688 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003689 validation_error_map[VALIDATION_ERROR_01600188]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003690 }
3691
3692 // subresource aspectMask must have exactly 1 bit set
3693 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
3694 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
3695 if (aspect_mask_bits.count() != 1) {
3696 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 -06003697 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a8, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003698 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003699 validation_error_map[VALIDATION_ERROR_016001a8]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003700 }
3701
3702 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003703 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003704 skip |= log_msg(
3705 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003706 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a6, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003707 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
3708 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003709 validation_error_map[VALIDATION_ERROR_016001a6]);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003710 }
3711
3712 // Checks that apply only to compressed images
3713 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
3714 // reserves a place for these compressed image checks. This block of code could move there once the image
3715 // stuff is moved into core validation.
Dave Houlton1d2022c2017-03-29 11:43:58 -06003716 if (FormatIsCompressed(image_state->createInfo.format)) {
3717 auto block_size = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003718
3719 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06003720 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003721 skip |= log_msg(
3722 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003723 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600196, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003724 "%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 -06003725 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01600196]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003726 }
3727
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003728 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003729 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003730 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 -06003731 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_01600198, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003732 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
3733 "height (%d). %s.",
3734 function, i, pRegions[i].bufferImageHeight, block_size.height,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003735 validation_error_map[VALIDATION_ERROR_01600198]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003736 }
3737
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003738 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06003739 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
3740 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
3741 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003742 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 -06003743 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019a, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003744 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
3745 "width & height (%d, %d). %s.",
3746 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003747 block_size.height, validation_error_map[VALIDATION_ERROR_0160019a]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003748 }
3749
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003750 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houlton1d2022c2017-03-29 11:43:58 -06003751 size_t block_size_in_bytes = FormatSize(image_state->createInfo.format);
3752 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003753 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 -06003754 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019c, "IMAGE",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003755 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
3756 ") must be a multiple of the compressed image's texel block "
3757 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
3758 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003759 validation_error_map[VALIDATION_ERROR_0160019c]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003760 }
Dave Houlton67e9b532017-03-02 17:00:10 -07003761
3762 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07003763 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06003764 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003765 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
3766 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 -06003767 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_0160019e, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003768 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
3769 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
3770 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003771 mip_extent.width, validation_error_map[VALIDATION_ERROR_0160019e]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003772 }
3773
3774 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06003775 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003776 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
3777 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003778 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a0, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003779 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
3780 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
3781 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003782 mip_extent.height, validation_error_map[VALIDATION_ERROR_016001a0]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003783 }
3784
3785 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06003786 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07003787 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
3788 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003789 HandleToUint64(image_state->image), __LINE__, VALIDATION_ERROR_016001a2, "IMAGE",
Dave Houlton75967fc2017-03-06 17:21:16 -07003790 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
3791 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
3792 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003793 mip_extent.depth, validation_error_map[VALIDATION_ERROR_016001a2]);
Dave Houlton67e9b532017-03-02 17:00:10 -07003794 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003795 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003796 }
3797
3798 return skip;
3799}
3800
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003801static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
3802 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003803 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003804 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003805
3806 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003807 VkExtent3D extent = pRegions[i].imageExtent;
3808 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003809
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003810 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
3811 {
3812 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3813 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
3814 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
3815 extent.height, extent.depth);
3816 }
3817
3818 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
3819
3820 // 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 -06003821 if (FormatIsCompressed(image_info->format)) {
3822 auto block_extent = FormatCompressedTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003823 if (image_extent.width % block_extent.width) {
3824 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
3825 }
3826 if (image_extent.height % block_extent.height) {
3827 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
3828 }
3829 if (image_extent.depth % block_extent.depth) {
3830 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
3831 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003832 }
3833
Dave Houltonfc1a4052017-04-27 14:32:45 -06003834 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003835 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 -07003836 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003837 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003838 }
3839 }
3840
3841 return skip;
3842}
3843
Chris Forbese8ba09a2017-06-01 17:39:02 -07003844static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06003845 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
3846 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003847 bool skip = false;
3848
3849 VkDeviceSize buffer_size = buff_state->createInfo.size;
3850
3851 for (uint32_t i = 0; i < regionCount; i++) {
3852 VkExtent3D copy_extent = pRegions[i].imageExtent;
3853
3854 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
3855 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houlton1d2022c2017-03-29 11:43:58 -06003856 VkDeviceSize unit_size = FormatSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003857
Dave Houltonf3229d52017-02-21 15:59:08 -07003858 // Handle special buffer packing rules for specific depth/stencil formats
3859 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houlton1d2022c2017-03-29 11:43:58 -06003860 unit_size = FormatSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003861 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3862 switch (image_state->createInfo.format) {
3863 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003864 unit_size = FormatSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07003865 break;
3866 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houlton1d2022c2017-03-29 11:43:58 -06003867 unit_size = FormatSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07003868 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003869 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07003870 case VK_FORMAT_D24_UNORM_S8_UINT:
3871 unit_size = 4;
3872 break;
3873 default:
3874 break;
3875 }
3876 }
3877
Dave Houlton1d2022c2017-03-29 11:43:58 -06003878 if (FormatIsCompressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003879 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houlton1d2022c2017-03-29 11:43:58 -06003880 auto block_dim = FormatCompressedTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003881 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
3882 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
3883
3884 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
3885 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
3886 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003887 }
3888
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003889 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
3890 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
3891 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07003892 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003893 } else {
3894 // Calculate buffer offset of final copied byte, + 1.
3895 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
3896 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
3897 max_buffer_offset *= unit_size; // convert to bytes
3898 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003899
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003900 if (buffer_size < max_buffer_offset) {
3901 skip |=
3902 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
3903 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
3904 i, buffer_size, validation_error_map[msg_code]);
3905 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003906 }
3907 }
3908
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003909 return skip;
3910}
3911
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003912bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003913 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003914 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003915 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3916 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
3917
3918 // Validate command buffer state
3919 if (CB_RECORDING != cb_node->state) {
3920 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 -06003921 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_19202413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003922 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003923 validation_error_map[VALIDATION_ERROR_19202413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003924 } else {
3925 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
3926 }
3927
3928 // Command pool must support graphics, compute, or transfer operations
3929 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3930
3931 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3932 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3933 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 -06003934 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_19202415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003935 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
3936 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003937 validation_error_map[VALIDATION_ERROR_19202415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003938 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003939 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003940 VALIDATION_ERROR_1920016c);
Chris Forbese8ba09a2017-06-01 17:39:02 -07003941 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houlton33c2d252017-06-09 17:08:32 -06003942 VALIDATION_ERROR_1920016e);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003943
3944 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003945 VALIDATION_ERROR_19200178);
3946 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200176);
3947 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200180);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003948
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003949 // Validate that SRC image & DST buffer have correct usage flags set
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003950 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_19200174,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003951 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003952 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
3953 VALIDATION_ERROR_1920017e, "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
3954 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_19200017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003955 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003956 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003957 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
3958 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_1920017c,
3959 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003960 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003961 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003962 }
3963 return skip;
3964}
3965
3966void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003967 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
3968 VkImageLayout src_image_layout) {
3969 // Make sure that all image slices are updated to correct layout
3970 for (uint32_t i = 0; i < region_count; ++i) {
3971 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
3972 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003973 // Update bindings between buffer/image and cmd buffer
3974 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003975 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003976
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003977 std::function<bool()> function = [=]() {
3978 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
3979 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003980 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003981 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003982 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003983 return false;
3984 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06003985 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003986}
3987
3988bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003989 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003990 const VkBufferImageCopy *pRegions, const char *func_name) {
3991 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3992 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
3993
3994 // Validate command buffer state
3995 if (CB_RECORDING != cb_node->state) {
3996 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 -06003997 HandleToUint64(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_18e02413, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003998 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06003999 validation_error_map[VALIDATION_ERROR_18e02413]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004000 } else {
4001 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
4002 }
4003
4004 // Command pool must support graphics, compute, or transfer operations
4005 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
4006 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
4007 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4008 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 -06004009 HandleToUint64(cb_node->createInfo.commandPool), __LINE__, VALIDATION_ERROR_18e02415, "DS",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004010 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
4011 "or transfer capabilities. %s.",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004012 validation_error_map[VALIDATION_ERROR_18e02415]);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004013 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004014 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004015 VALIDATION_ERROR_18e00158);
Chris Forbese8ba09a2017-06-01 17:39:02 -07004016 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houlton33c2d252017-06-09 17:08:32 -06004017 VALIDATION_ERROR_18e00156);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004018 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004019 VALIDATION_ERROR_18e00166);
4020 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00160);
4021 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00164);
4022 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4023 VALIDATION_ERROR_18e0015c, "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4024 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_18e00162,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004025 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004026 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e00017);
Tobin Ehlisc8266452017-04-07 12:20:30 -06004027 bool hit_error = false;
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004028 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004029 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
4030 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_18e0016a,
4031 &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004032 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
4033 "vkCmdCopyBufferToImage()");
4034 }
4035 return skip;
4036}
4037
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004038void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004039 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
4040 VkImageLayout dst_image_layout) {
4041 // Make sure that all image slices are updated to correct layout
4042 for (uint32_t i = 0; i < region_count; ++i) {
4043 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
4044 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004045 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004046 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004047 std::function<bool()> function = [=]() {
4048 SetImageMemoryValid(device_data, dst_image_state, true);
4049 return false;
4050 };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004051 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004052 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Tobin Ehlisa17a5292017-07-28 12:11:30 -06004053 cb_node->queue_submit_functions.push_back(function);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004054}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004055
4056bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
4057 const auto report_data = core_validation::GetReportData(device_data);
4058 bool skip = false;
4059 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4060
4061 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
4062 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4063 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4064 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004065 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 -06004066 __LINE__, VALIDATION_ERROR_2a6007ca, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004067 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004068 validation_error_map[VALIDATION_ERROR_2a6007ca]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004069 }
4070
4071 IMAGE_STATE *image_entry = GetImageState(device_data, image);
4072 if (!image_entry) {
4073 return skip;
4074 }
4075
4076 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
4077 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004078 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 -06004079 __LINE__, VALIDATION_ERROR_2a6007c8, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004080 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004081 validation_error_map[VALIDATION_ERROR_2a6007c8]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004082 }
4083
4084 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
4085 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004086 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 -06004087 __LINE__, VALIDATION_ERROR_0a4007cc, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004088 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004089 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_0a4007cc]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004090 }
4091
4092 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
4093 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004094 skip |=
4095 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4096 __LINE__, VALIDATION_ERROR_0a4007ce, "IMAGE",
4097 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
4098 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_0a4007ce]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004099 }
4100
4101 // VU 00741: subresource's aspect must be compatible with image's format.
4102 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d2022c2017-03-29 11:43:58 -06004103 if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004104 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
4105 skip |= log_msg(
Petr Krausbc7f5442017-05-14 23:43:38 +02004106 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 -06004107 VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004108 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004109 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004110 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004111 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004112 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004113 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 -06004114 HandleToUint64(image), __LINE__, VALIDATION_ERROR_0a400c01, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004115 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
4116 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004117 validation_error_map[VALIDATION_ERROR_0a400c01]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004118 }
4119 }
4120 return skip;
4121}