blob: 32c6d637c11f4711d432083fea8fae1722c91ff9 [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>
19 */
20
21// Allow use of STL min and max functions in Windows
22#define NOMINMAX
23
Mark Lobodzinski90224de2017-01-26 15:23:11 -070024#include <sstream>
25
26#include "vk_enum_string_helper.h"
27#include "vk_layer_data.h"
28#include "vk_layer_utils.h"
29#include "vk_layer_logging.h"
30
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070031#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070032
Tobin Ehlis58c884f2017-02-08 12:15:27 -070033void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070034 if (std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair) !=
35 pCB->imageSubresourceMap[imgpair.image].end()) {
36 pCB->imageLayoutMap[imgpair].layout = layout;
37 } else {
38 assert(imgpair.hasSubresource);
39 IMAGE_CMD_BUF_LAYOUT_NODE node;
40 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
41 node.initialLayout = layout;
42 }
43 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
44 }
45}
46template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070047void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070048 ImageSubresourcePair imgpair = {image, true, range};
49 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
50 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
51 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
53}
54
55template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070056void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070057 VkImageAspectFlags aspectMask) {
58 if (imgpair.subresource.aspectMask & aspectMask) {
59 imgpair.subresource.aspectMask = aspectMask;
60 SetLayout(device_data, pObject, imgpair, layout);
61 }
62}
63
Tony Barbourdf013b92017-01-25 12:53:48 -070064// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070065void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
66 VkImageLayout layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -070067 imageLayoutMap[imgpair].layout = layout;
68}
69
Tobin Ehlis58c884f2017-02-08 12:15:27 -070070bool FindLayoutVerifyNode(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070071 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
72 const debug_report_data *report_data = core_validation::GetReportData(device_data);
73
74 if (!(imgpair.subresource.aspectMask & aspectMask)) {
75 return false;
76 }
77 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
78 imgpair.subresource.aspectMask = aspectMask;
79 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
80 if (imgsubIt == pCB->imageLayoutMap.end()) {
81 return false;
82 }
83 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
84 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
85 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
86 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
87 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
88 string_VkImageLayout(imgsubIt->second.layout));
89 }
90 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
91 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
92 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
93 "Cannot query for VkImage 0x%" PRIx64
94 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
95 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
96 string_VkImageLayout(imgsubIt->second.initialLayout));
97 }
98 node = imgsubIt->second;
99 return true;
100}
101
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700102bool FindLayoutVerifyLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700103 const VkImageAspectFlags aspectMask) {
104 if (!(imgpair.subresource.aspectMask & aspectMask)) {
105 return false;
106 }
107 const debug_report_data *report_data = core_validation::GetReportData(device_data);
108 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
109 imgpair.subresource.aspectMask = aspectMask;
110 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
111 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
112 return false;
113 }
114 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
115 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
116 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
117 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
118 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
119 string_VkImageLayout(imgsubIt->second.layout));
120 }
121 layout = imgsubIt->second.layout;
122 return true;
123}
124
125// Find layout(s) on the command buffer level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700126bool FindCmdBufLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700127 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
128 ImageSubresourcePair imgpair = {image, true, range};
129 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
130 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
131 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
132 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
133 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
134 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
135 imgpair = {image, false, VkImageSubresource()};
136 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
137 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
138 // TODO: This is ostensibly a find function but it changes state here
139 node = imgsubIt->second;
140 }
141 return true;
142}
143
144// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700145bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700146 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
147 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
148 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
149 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
150 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
151 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
152 imgpair = {imgpair.image, false, VkImageSubresource()};
153 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
154 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
155 layout = imgsubIt->second.layout;
156 }
157 return true;
158}
159
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700160bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700161 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
162 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700163 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700164 if (!image_state) return false;
165 bool ignoreGlobal = false;
166 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
167 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
168 ignoreGlobal = true;
169 }
170 for (auto imgsubpair : sub_data->second) {
171 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
172 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
173 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
174 layouts.push_back(img_data->second.layout);
175 }
176 }
177 return true;
178}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700179bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
180 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700181 if (!(imgpair.subresource.aspectMask & aspectMask)) {
182 return false;
183 }
184 imgpair.subresource.aspectMask = aspectMask;
185 auto imgsubIt = imageLayoutMap.find(imgpair);
186 if (imgsubIt == imageLayoutMap.end()) {
187 return false;
188 }
189 layout = imgsubIt->second.layout;
190 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700191}
Tony Barbourdf013b92017-01-25 12:53:48 -0700192
193// find layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -0700194bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
195 VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700196 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
197 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
198 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
199 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
200 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
201 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
202 imgpair = {imgpair.image, false, VkImageSubresource()};
203 auto imgsubIt = imageLayoutMap.find(imgpair);
204 if (imgsubIt == imageLayoutMap.end()) return false;
205 layout = imgsubIt->second.layout;
206 }
207 return true;
208}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700209
210// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700211void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700212 VkImage &image = imgpair.image;
213 (*core_validation::GetImageLayoutMap(device_data))[imgpair].layout = layout;
214 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
215 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
216 if (subresource == image_subresources.end()) {
217 image_subresources.push_back(imgpair);
218 }
219}
220
221// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700222void 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 -0700223 pCB->imageLayoutMap[imgpair] = node;
224 auto subresource =
225 std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair);
226 if (subresource == pCB->imageSubresourceMap[imgpair.image].end()) {
227 pCB->imageSubresourceMap[imgpair.image].push_back(imgpair);
228 }
229}
230
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700231void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImageView imageView, const VkImageLayout &layout) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700232 auto view_state = GetImageViewState(device_data, imageView);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700233 assert(view_state);
234 auto image = view_state->create_info.image;
235 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
236 // TODO: Do not iterate over every possibility - consolidate where possible
237 for (uint32_t j = 0; j < subRange.levelCount; j++) {
238 uint32_t level = subRange.baseMipLevel + j;
239 for (uint32_t k = 0; k < subRange.layerCount; k++) {
240 uint32_t layer = subRange.baseArrayLayer + k;
241 VkImageSubresource sub = {subRange.aspectMask, level, layer};
242 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
243 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
244 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
245 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
246 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
247 }
248 }
249 SetLayout(device_data, pCB, image, sub, layout);
250 }
251 }
252}
253
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700254bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700255 const VkRenderPassBeginInfo *pRenderPassBegin,
256 const FRAMEBUFFER_STATE *framebuffer_state) {
257 bool skip_call = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700258 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700259 auto const &framebufferInfo = framebuffer_state->createInfo;
260 const auto report_data = core_validation::GetReportData(device_data);
261 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
262 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
263 DRAWSTATE_INVALID_RENDERPASS, "DS",
264 "You cannot start a render pass using a framebuffer "
265 "with a different number of attachments.");
266 }
267 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
268 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700269 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700270 assert(view_state);
271 const VkImage &image = view_state->create_info.image;
272 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
273 IMAGE_CMD_BUF_LAYOUT_NODE newNode = {pRenderPassInfo->pAttachments[i].initialLayout,
274 pRenderPassInfo->pAttachments[i].initialLayout};
275 // TODO: Do not iterate over every possibility - consolidate where possible
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700276 // TODO: Consolidate this with SetImageViewLayout() function above
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700277 for (uint32_t j = 0; j < subRange.levelCount; j++) {
278 uint32_t level = subRange.baseMipLevel + j;
279 for (uint32_t k = 0; k < subRange.layerCount; k++) {
280 uint32_t layer = subRange.baseArrayLayer + k;
281 VkImageSubresource sub = {subRange.aspectMask, level, layer};
282 IMAGE_CMD_BUF_LAYOUT_NODE node;
283 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700284 // If ImageView was created with depth or stencil, transition both aspects if it's a DS image
285 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
286 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
287 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
288 }
289 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700290 SetLayout(device_data, pCB, image, sub, newNode);
291 continue;
292 }
293 if (newNode.layout != VK_IMAGE_LAYOUT_UNDEFINED && newNode.layout != node.layout) {
294 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
295 DRAWSTATE_INVALID_RENDERPASS, "DS",
296 "You cannot start a render pass using attachment %u "
297 "where the render pass initial layout is %s and the previous "
298 "known layout of the attachment is %s. The layouts must match, or "
299 "the render pass initial layout for the attachment must be "
300 "VK_IMAGE_LAYOUT_UNDEFINED",
301 i, string_VkImageLayout(newNode.layout), string_VkImageLayout(node.layout));
302 }
303 }
304 }
305 }
306 return skip_call;
307}
308
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700309void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700310 VkAttachmentReference ref) {
311 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
312 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
313 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
314 }
315}
316
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700317void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
318 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700319 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700320 if (!renderPass) return;
321
322 if (framebuffer_state) {
323 auto const &subpass = renderPass->createInfo.pSubpasses[subpass_index];
324 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
325 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
326 }
327 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
328 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
329 }
330 if (subpass.pDepthStencilAttachment) {
331 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
332 }
333 }
334}
335
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700336bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
337 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700338 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
339 return false;
340 }
341 VkImageSubresource sub = {aspect, level, layer};
342 IMAGE_CMD_BUF_LAYOUT_NODE node;
343 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700344 return false;
345 }
346 bool skip = false;
347 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
348 // TODO: Set memory invalid which is in mem_tracker currently
349 } else if (node.layout != mem_barrier->oldLayout) {
350 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0,
351 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
352 "You cannot transition the layout of aspect %d from %s when current layout is %s.", aspect,
353 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
354 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700355 return skip;
356}
357
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700358void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
359 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
360 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
361 return;
362 }
363 VkImageSubresource sub = {aspect, level, layer};
364 IMAGE_CMD_BUF_LAYOUT_NODE node;
365 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
366 SetLayout(device_data, pCB, mem_barrier->image, sub,
367 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
368 return;
369 }
370 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
371 // TODO: Set memory invalid
372 }
373 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
374}
375
Mike Weiblen62d08a32017-03-07 22:18:27 -0700376// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
377bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
378 VkImageUsageFlags usage_flags, const char *func_name) {
379 const auto report_data = core_validation::GetReportData(device_data);
380 bool skip = false;
381 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
382 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
383
384 switch (layout) {
385 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
386 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
387 msg_code = VALIDATION_ERROR_00303;
388 }
389 break;
390 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
391 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
392 msg_code = VALIDATION_ERROR_00304;
393 }
394 break;
395 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
396 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
397 msg_code = VALIDATION_ERROR_00305;
398 }
399 break;
400 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
401 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
402 msg_code = VALIDATION_ERROR_00306;
403 }
404 break;
405 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
406 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
407 msg_code = VALIDATION_ERROR_00307;
408 }
409 break;
410 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
411 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
412 msg_code = VALIDATION_ERROR_00308;
413 }
414 break;
415 default:
416 // Other VkImageLayout values do not have VUs defined in this context.
417 break;
418 }
419
420 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
421 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, msg_code,
422 "DS", "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32
423 ". %s",
424 func_name, img_barrier, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
425 (uint64_t)(img_barrier->image), usage_flags, validation_error_map[msg_code]);
426 }
427 return skip;
428}
429
430// Verify image barriers are compatible with the images they reference.
431bool ValidateBarriersToImages(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t imageMemoryBarrierCount,
432 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700433 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700434 bool skip = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700435 uint32_t level_count = 0;
436 uint32_t layer_count = 0;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700437
Mike Weiblen62d08a32017-03-07 22:18:27 -0700438 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
439 auto img_barrier = &pImageMemoryBarriers[i];
440 if (!img_barrier) continue;
441
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700442 // TODO: Do not iterate over every possibility - consolidate where possible
Mike Weiblen62d08a32017-03-07 22:18:27 -0700443 ResolveRemainingLevelsLayers(device_data, &level_count, &layer_count, img_barrier->subresourceRange,
444 GetImageState(device_data, img_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700445
Mike Weiblen62d08a32017-03-07 22:18:27 -0700446 for (uint32_t j = 0; j < level_count; j++) {
447 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
448 for (uint32_t k = 0; k < layer_count; k++) {
449 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
450 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
451 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
452 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
453 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700454 }
455 }
Mike Weiblen62d08a32017-03-07 22:18:27 -0700456
457 IMAGE_STATE *image_state = GetImageState(device_data, img_barrier->image);
458 if (image_state) {
459 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
460 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
461 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
462 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700463 }
464 return skip;
465}
466
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700467void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
468 const VkImageMemoryBarrier *pImgMemBarriers) {
469 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
470 uint32_t levelCount = 0;
471 uint32_t layerCount = 0;
472
473 for (uint32_t i = 0; i < memBarrierCount; ++i) {
474 auto mem_barrier = &pImgMemBarriers[i];
475 if (!mem_barrier) continue;
476 // TODO: Do not iterate over every possibility - consolidate where possible
477 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
478 GetImageState(device_data, mem_barrier->image));
479
480 for (uint32_t j = 0; j < levelCount; j++) {
481 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
482 for (uint32_t k = 0; k < layerCount; k++) {
483 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
484 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
485 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
486 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
487 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
488 }
489 }
490 }
491}
492
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700493bool VerifySourceImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage srcImage, VkImageSubresourceLayers subLayers,
494 VkImageLayout srcImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700495 const auto report_data = core_validation::GetReportData(device_data);
496 bool skip_call = false;
497
498 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
499 uint32_t layer = i + subLayers.baseArrayLayer;
500 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
501 IMAGE_CMD_BUF_LAYOUT_NODE node;
502 if (!FindCmdBufLayout(device_data, cb_node, srcImage, sub, node)) {
503 SetLayout(device_data, cb_node, srcImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(srcImageLayout, srcImageLayout));
504 continue;
505 }
506 if (node.layout != srcImageLayout) {
507 // TODO: Improve log message in the next pass
508 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
509 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
510 "Cannot copy from an image whose source layout is %s "
511 "and doesn't match the current layout %s.",
512 string_VkImageLayout(srcImageLayout), string_VkImageLayout(node.layout));
513 }
514 }
515 if (srcImageLayout != VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) {
516 if (srcImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
517 // TODO : Can we deal with image node from the top of call tree and avoid map look-up here?
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700518 auto image_state = GetImageState(device_data, srcImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700519 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
520 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
521 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
522 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
523 "Layout for input image should be TRANSFER_SRC_OPTIMAL instead of GENERAL.");
524 }
525 } else {
526 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
527 "DS", "Layout for input image is %s but can only be TRANSFER_SRC_OPTIMAL or GENERAL. %s",
528 string_VkImageLayout(srcImageLayout), validation_error_map[msgCode]);
529 }
530 }
531 return skip_call;
532}
533
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700534bool VerifyDestImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage destImage, VkImageSubresourceLayers subLayers,
535 VkImageLayout destImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700536 const auto report_data = core_validation::GetReportData(device_data);
537 bool skip_call = false;
538
539 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
540 uint32_t layer = i + subLayers.baseArrayLayer;
541 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
542 IMAGE_CMD_BUF_LAYOUT_NODE node;
543 if (!FindCmdBufLayout(device_data, cb_node, destImage, sub, node)) {
544 SetLayout(device_data, cb_node, destImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(destImageLayout, destImageLayout));
545 continue;
546 }
547 if (node.layout != destImageLayout) {
548 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
549 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
550 "Cannot copy from an image whose dest layout is %s and "
551 "doesn't match the current layout %s.",
552 string_VkImageLayout(destImageLayout), string_VkImageLayout(node.layout));
553 }
554 }
555 if (destImageLayout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
556 if (destImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700557 auto image_state = GetImageState(device_data, destImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700558 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
559 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
560 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
561 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
562 "Layout for output image should be TRANSFER_DST_OPTIMAL instead of GENERAL.");
563 }
564 } else {
565 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
566 "DS", "Layout for output image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s",
567 string_VkImageLayout(destImageLayout), validation_error_map[msgCode]);
568 }
569 }
570 return skip_call;
571}
572
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700573void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
574 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700575 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700576 if (!renderPass) return;
577
578 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
579 if (framebuffer_state) {
580 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
581 auto image_view = framebuffer_state->createInfo.pAttachments[i];
582 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
583 }
584 }
585}
586
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700587bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700588 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
589 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700590 const debug_report_data *report_data = core_validation::GetReportData(device_data);
591
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600592 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700593 skip_call |=
594 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
595 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
596 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600597
598 return skip_call;
599 }
600
601 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
602
603 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
604 std::stringstream ss;
605 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
606 skip_call |=
607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
608 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
609
610 return skip_call;
611 }
612
613 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
614 std::stringstream ss;
615 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
616 skip_call |=
617 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
618 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
619
620 return skip_call;
621 }
622
623 // Validate that format supports usage as color attachment
624 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
625 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
626 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
627 std::stringstream ss;
628 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
629 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
630 skip_call |=
631 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
632 VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
633 }
634 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
635 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
636 std::stringstream ss;
637 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
638 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
639 skip_call |=
640 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
641 VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
642 }
643 }
644
645 // Validate that format supports usage as depth/stencil attachment
646 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
647 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
648 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
649 std::stringstream ss;
650 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
651 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
652 skip_call |=
653 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
654 VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
655 }
656 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
657 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
658 std::stringstream ss;
659 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
660 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
661 skip_call |=
662 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
663 VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
664 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700665 }
666
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700667 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
668 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700669
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700670 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700671 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
672
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700673 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
674 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
675 VALIDATION_ERROR_00716, "Image",
676 "CreateImage extent is 0 for at least one required dimension for image: "
677 "Width = %d Height = %d Depth = %d. %s",
678 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
679 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700680 }
681
682 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
683 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700684 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
685 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
686 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700687 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
688 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
689 "CreateImage extents exceed allowable limits for format: "
690 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
691 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700692 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
693 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700694 }
695
696 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
697 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
698 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
699 (uint64_t)imageGranularity) &
700 ~(uint64_t)imageGranularity;
701
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700702 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700703 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
704 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
705 "CreateImage resource size exceeds allowable maximum "
706 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700707 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700708 }
709
710 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700711 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700712 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
713 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
714 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700715 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700716 }
717
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700718 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700719 skip_call |= log_msg(
720 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
721 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700722 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700723 }
724
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700725 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700726 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
727 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700728 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700729 validation_error_map[VALIDATION_ERROR_02138]);
730 }
731
732 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
733 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
734 VALIDATION_ERROR_00731, "Image",
735 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
736 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
737 validation_error_map[VALIDATION_ERROR_00731]);
738 }
739
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600740 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
741 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
742 VALIDATION_ERROR_02143, "DS",
743 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
744 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
745 validation_error_map[VALIDATION_ERROR_02143]);
746 }
747
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600748 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
749 skip_call |=
750 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
751 DRAWSTATE_INVALID_FEATURE, "DS",
752 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
753 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
754 }
755
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700756 return skip_call;
757}
758
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700759void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700760 IMAGE_LAYOUT_NODE image_state;
761 image_state.layout = pCreateInfo->initialLayout;
762 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700763 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 -0700764 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700765 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
766 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700767}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700768
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700769bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700770 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700771 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700772 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
773 if (disabled->destroy_image) return false;
774 bool skip = false;
775 if (*image_state) {
776 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
777 }
778 return skip;
779}
780
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700781void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700782 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
783 // Clean up memory mapping, bindings and range references for image
784 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700785 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700786 if (mem_info) {
787 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
788 }
789 }
790 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
791 // Remove image from imageMap
792 core_validation::GetImageMap(device_data)->erase(image);
793 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
794 core_validation::GetImageSubresourceMap(device_data);
795
796 const auto &sub_entry = imageSubresourceMap->find(image);
797 if (sub_entry != imageSubresourceMap->end()) {
798 for (const auto &pair : sub_entry->second) {
799 core_validation::GetImageLayoutMap(device_data)->erase(pair);
800 }
801 imageSubresourceMap->erase(sub_entry);
802 }
803}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700804
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700805bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700806 bool skip = false;
807 const debug_report_data *report_data = core_validation::GetReportData(device_data);
808
809 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
810 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
811 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
812 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
813 }
814
815 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
816 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
817 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
818 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
819 validation_error_map[VALIDATION_ERROR_01088]);
820 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
821 char const str[] = "vkCmdClearColorImage called with compressed image.";
822 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
823 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
824 validation_error_map[VALIDATION_ERROR_01088]);
825 }
826
827 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
828 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
829 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
830 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
831 validation_error_map[VALIDATION_ERROR_01084]);
832 }
833 return skip;
834}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700835
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700836void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700837 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
838 // internal state to the actual values.
839 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
840 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
841 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700842
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700843 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
844 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700845 }
846}
847
848// Return the correct layer/level counts if the caller used the special values VK_REMAINING_MIP_LEVELS or VK_REMAINING_ARRAY_LAYERS.
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700849void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
850 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700851 *levels = range.levelCount;
852 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700853 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
854 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
855 }
856 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
857 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700858 }
859}
860
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700861bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700862 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
863 bool skip = false;
864 const debug_report_data *report_data = core_validation::GetReportData(device_data);
865
866 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700867 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700868
869 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
870 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700871 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
872 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
873 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
874 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
875 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
876 }
877 } else {
878 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
879 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
880 error_code = VALIDATION_ERROR_01101;
881 } else {
882 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
883 }
884 skip |=
885 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, error_code, "DS",
886 "%s: Layout for cleared image is %s but can only be "
887 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
888 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
889 }
890 }
891
892 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
893 uint32_t level = level_index + resolved_range.baseMipLevel;
894 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
895 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
896 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
897 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700898 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700899 if (node.layout != dest_image_layout) {
900 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
901 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
902 error_code = VALIDATION_ERROR_01100;
903 } else {
904 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
905 }
906 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
907 __LINE__, error_code, "DS",
908 "%s: Cannot clear an image whose layout is %s and "
909 "doesn't match the current layout %s. %s",
910 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
911 validation_error_map[error_code]);
912 }
913 }
914 }
915 }
916
917 return skip;
918}
919
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700920void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
921 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700922 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700923 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700924
925 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
926 uint32_t level = level_index + resolved_range.baseMipLevel;
927 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
928 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
929 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
930 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700931 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
932 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 -0700933 }
934 }
935 }
936}
937
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700938bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700939 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
940 bool skip = false;
941 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700942 auto cb_node = GetCBNode(dev_data, commandBuffer);
943 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700944 if (cb_node && image_state) {
945 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
946 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
947 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
948 for (uint32_t i = 0; i < rangeCount; ++i) {
949 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700950 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700951 }
952 }
953 return skip;
954}
955
956// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700957void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
958 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700959 auto cb_node = GetCBNode(dev_data, commandBuffer);
960 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700961 if (cb_node && image_state) {
962 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
963 std::function<bool()> function = [=]() {
964 SetImageMemoryValid(dev_data, image_state, true);
965 return false;
966 };
967 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700968 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700969 for (uint32_t i = 0; i < rangeCount; ++i) {
970 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
971 }
972 }
973}
974
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700975bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
976 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700977 const VkImageSubresourceRange *pRanges) {
978 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700979 const debug_report_data *report_data = core_validation::GetReportData(device_data);
980
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700981 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700982 auto cb_node = GetCBNode(device_data, commandBuffer);
983 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700984 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700985 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
986 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
987 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700988 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700989 skip |=
990 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700991 // Image aspect must be depth or stencil or both
992 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
993 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
994 char const str[] =
995 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
996 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
997 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
998 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
999 }
1000 }
1001 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
1002 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
1003 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1004 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
1005 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001006 }
1007 }
1008 return skip;
1009}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001010
1011// Returns true if [x, xoffset] and [y, yoffset] overlap
1012static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1013 bool result = false;
1014 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1015 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1016
1017 if (intersection_max > intersection_min) {
1018 result = true;
1019 }
1020 return result;
1021}
1022
1023// Returns true if two VkImageCopy structures overlap
1024static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1025 bool result = false;
1026 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1027 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1028 dst->dstSubresource.layerCount))) {
1029 result = true;
1030 switch (type) {
1031 case VK_IMAGE_TYPE_3D:
1032 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1033 // Intentionally fall through to 2D case
1034 case VK_IMAGE_TYPE_2D:
1035 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1036 // Intentionally fall through to 1D case
1037 case VK_IMAGE_TYPE_1D:
1038 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1039 break;
1040 default:
1041 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1042 assert(false);
1043 }
1044 }
1045 return result;
1046}
1047
1048// Returns true if offset and extent exceed image extents
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001049static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001050 bool result = false;
1051 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001052 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1053 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
1054 result = true;
1055 }
1056 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1057 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
1058 result = true;
1059 }
1060 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1061 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
1062 result = true;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001063 }
1064 return result;
1065}
1066
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001067// Test if two VkExtent3D structs are equivalent
1068static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1069 bool result = true;
1070 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1071 (extent->depth != other_extent->depth)) {
1072 result = false;
1073 }
1074 return result;
1075}
1076
1077// Returns the image extent of a specific subresource.
1078static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1079 const uint32_t mip = subresource->mipLevel;
1080 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001081 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
1082 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1083 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1084 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001085 return extent;
1086}
1087
1088// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001089static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001090 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1091}
1092
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001093// Test if the extent argument has any dimensions set to 0.
1094static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1095 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1096}
1097
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001098// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1099static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1100 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1101 VkExtent3D granularity = {0, 0, 0};
1102 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1103 if (pPool) {
1104 granularity =
1105 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
1106 if (vk_format_is_compressed(img->createInfo.format)) {
Mark Lobodzinski13086442017-02-24 08:53:14 -07001107 auto block_size = vk_format_compressed_texel_block_extents(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001108 granularity.width *= block_size.width;
1109 granularity.height *= block_size.height;
1110 }
1111 }
1112 return granularity;
1113}
1114
1115// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1116static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1117 bool valid = true;
1118 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
1119 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
1120 valid = false;
1121 }
1122 return valid;
1123}
1124
1125// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1126static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1127 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1128 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1129 bool skip = false;
1130 VkExtent3D offset_extent = {};
1131 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1132 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1133 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001134 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001135 // 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 -07001136 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001137 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1138 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1139 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1140 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1141 function, i, member, offset->x, offset->y, offset->z);
1142 }
1143 } else {
1144 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1145 // integer multiples of the image transfer granularity.
1146 if (IsExtentAligned(&offset_extent, granularity) == false) {
1147 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1148 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1149 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1150 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1151 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1152 granularity->depth);
1153 }
1154 }
1155 return skip;
1156}
1157
1158// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1159static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1160 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1161 const uint32_t i, const char *function, const char *member) {
1162 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1163 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001164 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001165 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1166 // subresource extent.
1167 if (IsExtentEqual(extent, subresource_extent) == false) {
1168 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1169 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1170 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1171 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1172 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1173 subresource_extent->height, subresource_extent->depth);
1174 }
1175 } else {
1176 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1177 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1178 // subresource extent dimensions.
1179 VkExtent3D offset_extent_sum = {};
1180 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1181 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1182 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1183 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1184 skip |=
1185 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1186 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1187 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1188 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1189 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1190 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1191 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1192 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1193 }
1194 }
1195 return skip;
1196}
1197
1198// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1199static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1200 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1201 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1202
1203 bool skip = false;
1204 if (vk_safe_modulo(value, granularity) != 0) {
1205 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1206 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1207 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1208 "transfer granularity width (%d).",
1209 function, i, member, value, granularity);
1210 }
1211 return skip;
1212}
1213
1214// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1215static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1216 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1217 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1218 bool skip = false;
1219 if (vk_safe_modulo(value, granularity) != 0) {
1220 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1221 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1222 "%s: pRegion[%d].%s (%" PRIdLEAST64
1223 ") must be an even integer multiple of this command buffer's queue family image transfer "
1224 "granularity width (%d).",
1225 function, i, member, value, granularity);
1226 }
1227 return skip;
1228}
1229
1230// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1231bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1232 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1233 const uint32_t i, const char *function) {
1234 bool skip = false;
1235 if (vk_format_is_compressed(img->createInfo.format) == true) {
1236 // TODO: Add granularity checking for compressed formats
1237
1238 // bufferRowLength must be a multiple of the compressed texel block width
1239 // bufferImageHeight must be a multiple of the compressed texel block height
1240 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1241 // bufferOffset must be a multiple of the compressed texel block size in bytes
1242 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1243 // must equal the image subresource width
1244 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1245 // must equal the image subresource height
1246 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1247 // must equal the image subresource depth
1248 } else {
1249 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1250 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1251 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1252 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1253 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1254 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1255 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1256 i, function, "imageExtent");
1257 }
1258 return skip;
1259}
1260
1261// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1262bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1263 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1264 const char *function) {
1265 bool skip = false;
1266 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1267 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1268 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1269 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1270 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1271 function, "extent");
1272 return skip;
1273}
1274
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001275bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001276 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1277 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001278 bool skip = false;
1279 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1280 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1281
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001282 for (uint32_t i = 0; i < region_count; i++) {
1283 if (regions[i].srcSubresource.layerCount == 0) {
1284 std::stringstream ss;
1285 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1286 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1287 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1288 ss.str().c_str());
1289 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001290
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001291 if (regions[i].dstSubresource.layerCount == 0) {
1292 std::stringstream ss;
1293 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1294 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1295 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1296 ss.str().c_str());
1297 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001298
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001299 // For each region the layerCount member of srcSubresource and dstSubresource must match
1300 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1301 std::stringstream ss;
1302 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1303 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1304 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1305 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1306 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001307
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001308 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1309 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1310 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1311 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1312 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1313 validation_error_map[VALIDATION_ERROR_01197]);
1314 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001315
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001316 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1317 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1318 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1319 std::stringstream ss;
1320 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1321 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1322 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1323 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1324 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001325
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001326 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1327 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1328 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1329 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1330 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1331 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1332 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1333 validation_error_map[VALIDATION_ERROR_01221]);
1334 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001335
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001336 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1337 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1338 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1339 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1340 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1341 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1342 std::stringstream ss;
1343 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1344 << "] baseArrayLayer was not zero or layerCount was not 1.";
1345 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1346 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1347 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1348 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001349
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001350 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1351 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1352 std::stringstream ss;
1353 ss << "vkCmdCopyImage: pRegions[" << i
1354 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1356 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1357 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1358 }
1359 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1360 std::stringstream ss;
1361 ss << "vkCmdCopyImage: pRegions[" << i
1362 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1363 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1364 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1365 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1366 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001367
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001368 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1369 // image was created
1370 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1371 src_image_state->createInfo.arrayLayers) {
1372 std::stringstream ss;
1373 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1374 << "] baseArrayLayer + layerCount is "
1375 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1377 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1378 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1379 }
1380 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1381 dst_image_state->createInfo.arrayLayers) {
1382 std::stringstream ss;
1383 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1384 << "] baseArrayLayer + layerCount is "
1385 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1386 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1387 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1388 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1389 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001390
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001391 // The source region specified by a given element of regions must be a region that is contained within srcImage
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001392 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &(src_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001393 std::stringstream ss;
1394 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1395 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1396 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1397 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1398 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001399
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001400 // The destination region specified by a given element of regions must be a region that is contained within dst_image
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001401 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &(dst_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001402 std::stringstream ss;
1403 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1404 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1405 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1406 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1407 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001408
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001409 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1410 // must not overlap in memory
1411 if (src_image_state->image == dst_image_state->image) {
1412 for (uint32_t j = 0; j < region_count; j++) {
1413 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1414 std::stringstream ss;
1415 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1416 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1417 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1418 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001419 }
1420 }
1421 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001422 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001423
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001424 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1425 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1426 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1427 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1428 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1429 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1430 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1431 skip |=
1432 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1433 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1434 }
1435 } else {
1436 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1437 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1438 if (srcSize != destSize) {
1439 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1440 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1441 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1442 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001443 }
1444 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001445
1446 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1447 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1448 // Validate that SRC & DST images have correct usage flags set
1449 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1450 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1451 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1452 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
1453 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1454 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1455 for (uint32_t i = 0; i < region_count; ++i) {
1456 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, regions[i].srcSubresource, src_image_layout,
1457 VALIDATION_ERROR_01180);
1458 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, regions[i].dstSubresource, dst_image_layout,
1459 VALIDATION_ERROR_01183);
1460 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1461 "vkCmdCopyImage()");
1462 }
1463
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001464 return skip;
1465}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001466
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001467void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1468 IMAGE_STATE *dst_image_state) {
1469 // Update bindings between images and cmd buffer
1470 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1471 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07001472 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001473 cb_node->validate_functions.push_back(function);
1474 function = [=]() {
1475 SetImageMemoryValid(device_data, dst_image_state, true);
1476 return false;
1477 };
1478 cb_node->validate_functions.push_back(function);
1479 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1480}
1481
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001482// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1483// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1484// to that same cmd buffer by separate thread are not changing state from underneath us
1485// Track the last cmd buffer touched by this thread
1486static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1487 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1488 if (pCB->drawCount[i]) return true;
1489 }
1490 return false;
1491}
1492
1493// Returns true if sub_rect is entirely contained within rect
1494static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1495 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1496 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1497 return false;
1498 return true;
1499}
1500
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001501bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1502 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001503 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001504 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1505
1506 bool skip = false;
1507 if (cb_node) {
1508 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001509 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001510 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1511 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1512 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1513 // 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 -07001514 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
1515 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001516 skip |=
1517 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1518 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1519 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1520 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1521 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001522 }
1523 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1524 }
1525
1526 // Validate that attachment is in reference list of active subpass
1527 if (cb_node->activeRenderPass) {
1528 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1529 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001530 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001531
1532 for (uint32_t i = 0; i < attachmentCount; i++) {
1533 auto clear_desc = &pAttachments[i];
1534 VkImageView image_view = VK_NULL_HANDLE;
1535
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001536 if (0 == clear_desc->aspectMask) {
1537 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1538 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
1539 validation_error_map[VALIDATION_ERROR_01128]);
1540 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1541 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1542 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
1543 validation_error_map[VALIDATION_ERROR_01126]);
1544 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001545 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001546 skip |=
1547 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1548 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01114, "DS",
1549 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1550 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001551 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1552 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001553 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1554 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1555 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1556 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001557 } else {
1558 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001559 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001560 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001561 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1562 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1563 char const str[] =
1564 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1565 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1566 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
1567 validation_error_map[VALIDATION_ERROR_01125]);
1568 }
1569 } else { // Must be depth and/or stencil
1570 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1571 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1572 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1573 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1574 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
1575 validation_error_map[VALIDATION_ERROR_01127]);
1576 }
1577 if (!subpass_desc->pDepthStencilAttachment ||
1578 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1579 skip |= log_msg(
1580 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1581 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1582 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001583 } else {
1584 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1585 }
1586 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001587 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001588 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001589 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001590 // The rectangular region specified by a given element of pRects must be contained within the render area of
1591 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001592 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
1593 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
1594 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001595 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1596 __LINE__, VALIDATION_ERROR_01115, "DS",
1597 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1598 "the current render pass instance. %s",
1599 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001600 }
1601 // The layers specified by a given element of pRects must be contained within every attachment that
1602 // pAttachments refers to
1603 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1604 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1605 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1606 skip |=
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1608 __LINE__, VALIDATION_ERROR_01116, "DS",
1609 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1610 "pAttachment[%d]. %s",
1611 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001612 }
1613 }
1614 }
1615 }
1616 }
1617 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001618}
1619
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001620bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001621 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001622 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001623 bool skip = false;
1624 if (cb_node && src_image_state && dst_image_state) {
1625 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1626 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
1627 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1628 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001629
1630 // For each region, the number of layers in the image subresource should not be zero
1631 // For each region, src and dest image aspect must be color only
1632 for (uint32_t i = 0; i < regionCount; i++) {
1633 if (pRegions[i].srcSubresource.layerCount == 0) {
1634 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001635 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001636 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1637 "IMAGE", str);
1638 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001639 if (pRegions[i].dstSubresource.layerCount == 0) {
1640 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001641 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001642 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1643 "IMAGE", str);
1644 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001645 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1646 skip |= log_msg(
1647 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1648 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1649 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1650 validation_error_map[VALIDATION_ERROR_01339]);
1651 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001652 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1653 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1654 char const str[] =
1655 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1656 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1657 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1658 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1659 }
1660 }
1661
1662 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1663 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001664 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001665 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1666 "IMAGE", str);
1667 }
1668 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1669 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001670 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001671 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1672 str);
1673 }
1674 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1675 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1676 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1677 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1678 str, validation_error_map[VALIDATION_ERROR_01320]);
1679 }
1680 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1681 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1682 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1683 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1684 str, validation_error_map[VALIDATION_ERROR_01321]);
1685 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001686 } else {
1687 assert(0);
1688 }
1689 return skip;
1690}
1691
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001692void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1693 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001694 // Update bindings between images and cmd buffer
1695 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1696 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1697
1698 std::function<bool()> function = [=]() {
1699 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1700 };
1701 cb_node->validate_functions.push_back(function);
1702 function = [=]() {
1703 SetImageMemoryValid(device_data, dst_image_state, true);
1704 return false;
1705 };
1706 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001707 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001708}
1709
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001710bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001711 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1712 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1713
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001714 bool skip = false;
1715 if (cb_node && src_image_state && dst_image_state) {
1716 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001717 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001718 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001719 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001720 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1721 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1722 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001723 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001724 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001725 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001726 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1727 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001728
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001729 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001730 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001731 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1732 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1733 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1734 std::stringstream ss;
1735 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1736 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1737 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1738 "%s", ss.str().c_str());
1739 }
1740 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1741 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1742 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1743 std::stringstream ss;
1744 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1745 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1746 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1747 "%s", ss.str().c_str());
1748 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001749 if (pRegions[i].srcSubresource.layerCount == 0) {
1750 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1751 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltoneba86e22017-03-02 14:56:23 -07001752 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1753 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001754 }
1755 if (pRegions[i].dstSubresource.layerCount == 0) {
1756 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1757 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltoneba86e22017-03-02 14:56:23 -07001758 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1759 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001760 }
1761
1762 // Check that src/dst layercounts match
1763 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1764 skip |=
1765 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1766 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1767 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1768 i, validation_error_map[VALIDATION_ERROR_01304]);
1769 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001770
1771 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1772 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1773 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1774 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1775 validation_error_map[VALIDATION_ERROR_01303]);
1776 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001777 }
1778
1779 VkFormat src_format = src_image_state->createInfo.format;
1780 VkFormat dst_format = dst_image_state->createInfo.format;
1781
1782 // Validate consistency for unsigned formats
1783 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1784 std::stringstream ss;
1785 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1786 << "the other one must also have unsigned integer format. "
1787 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1788 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1789 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1790 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1791 }
1792
1793 // Validate consistency for signed formats
1794 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1795 std::stringstream ss;
1796 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1797 << "the other one must also have signed integer format. "
1798 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1799 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1800 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1801 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1802 }
1803
1804 // Validate aspect bits and formats for depth/stencil images
1805 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
1806 if (src_format != dst_format) {
1807 std::stringstream ss;
1808 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1809 << "stencil, the other one must have exactly the same format. "
1810 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1811 << string_VkFormat(dst_format);
1812 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1813 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1814 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1815 }
1816
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001817 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001818 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001819
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001820 if (vk_format_is_depth_and_stencil(src_format)) {
1821 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1822 std::stringstream ss;
1823 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1824 "VK_IMAGE_ASPECT_DEPTH_BIT "
1825 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1826 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1827 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1828 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1829 }
1830 } else if (vk_format_is_stencil_only(src_format)) {
1831 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1832 std::stringstream ss;
1833 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1834 << "set in both the srcImage and dstImage";
1835 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1836 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1837 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1838 }
1839 } else if (vk_format_is_depth_only(src_format)) {
1840 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1841 std::stringstream ss;
1842 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1843 << "set in both the srcImage and dstImage";
1844 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1845 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1846 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1847 }
1848 }
1849 }
1850 }
1851
1852 // Validate filter
1853 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1854 std::stringstream ss;
1855 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1856 << "then filter must be VK_FILTER_NEAREST.";
1857 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1858 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1859 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1860 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001861 } else {
1862 assert(0);
1863 }
1864 return skip;
1865}
1866
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001867void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1868 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001869 // Update bindings between images and cmd buffer
1870 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1871 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1872
1873 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1874 cb_node->validate_functions.push_back(function);
1875 function = [=]() {
1876 SetImageMemoryValid(device_data, dst_image_state, true);
1877 return false;
1878 };
1879 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001880 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001881}
1882
Tony Barbourdf013b92017-01-25 12:53:48 -07001883// This validates that the initial layout specified in the command buffer for
1884// the IMAGE is the same
1885// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001886bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1887 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001888 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001889 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001890 for (auto cb_image_data : pCB->imageLayoutMap) {
1891 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001892
Jeremy Hayes55b6c292017-02-28 09:44:45 -07001893 if (FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001894 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1895 // TODO: Set memory invalid which is in mem_tracker currently
1896 } else if (imageLayout != cb_image_data.second.initialLayout) {
1897 if (cb_image_data.first.hasSubresource) {
Dave Houltoneba86e22017-03-02 14:56:23 -07001898 skip |= log_msg(
1899 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1900 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1901 "Cannot submit cmd buffer using image (0x%" PRIx64
1902 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1903 "with layout %s when first use is %s.",
1904 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
1905 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
1906 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001907 } else {
Dave Houltoneba86e22017-03-02 14:56:23 -07001908 skip |=
1909 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1910 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1911 "Cannot submit cmd buffer using image (0x%" PRIx64
1912 ") with layout %s when "
1913 "first use is %s.",
1914 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), string_VkImageLayout(imageLayout),
1915 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001916 }
1917 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001918 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001919 }
1920 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001921 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001922}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001923
Tony Barbourdf013b92017-01-25 12:53:48 -07001924void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1925 for (auto cb_image_data : pCB->imageLayoutMap) {
1926 VkImageLayout imageLayout;
1927 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1928 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1929 }
1930}
1931
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001932// Print readable FlagBits in FlagMask
1933static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1934 std::string result;
1935 std::string separator;
1936
1937 if (accessMask == 0) {
1938 result = "[None]";
1939 } else {
1940 result = "[";
1941 for (auto i = 0; i < 32; i++) {
1942 if (accessMask & (1 << i)) {
1943 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1944 separator = " | ";
1945 }
1946 }
1947 result = result + "]";
1948 }
1949 return result;
1950}
1951
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001952// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1953// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001954// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001955static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
1956 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
1957 const char *type) {
1958 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1959 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001960
1961 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
1962 if (accessMask & ~(required_bit | optional_bits)) {
1963 // TODO: Verify against Valid Use
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001964 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1965 DRAWSTATE_INVALID_BARRIER, "DS",
1966 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1967 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001968 }
1969 } else {
1970 if (!required_bit) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001971 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1972 DRAWSTATE_INVALID_BARRIER, "DS",
1973 "%s AccessMask %d %s must contain at least one of access bits %d "
1974 "%s when layout is %s, unless the app has previously added a "
1975 "barrier for this transition.",
1976 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
1977 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001978 } else {
1979 std::string opt_bits;
1980 if (optional_bits != 0) {
1981 std::stringstream ss;
1982 ss << optional_bits;
1983 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
1984 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001985 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1986 DRAWSTATE_INVALID_BARRIER, "DS",
1987 "%s AccessMask %d %s must have required access bit %d %s %s when "
1988 "layout is %s, unless the app has previously added a barrier for "
1989 "this transition.",
1990 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
1991 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001992 }
1993 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001994 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001995}
1996
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001997bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
1998 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
1999 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002000
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002001 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002002 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002003 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
2004 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
2005 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2006 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002007 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002008 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
2009 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
2010 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2011 break;
2012 }
2013 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
2014 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
2015 break;
2016 }
2017 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
2018 skip |= ValidateMaskBits(
2019 device_data, cmdBuffer, accessMask, layout, 0,
2020 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
2021 type);
2022 break;
2023 }
2024 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
2025 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
2026 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
2027 break;
2028 }
2029 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
2030 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
2031 break;
2032 }
2033 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
2034 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
2035 break;
2036 }
2037 case VK_IMAGE_LAYOUT_UNDEFINED: {
2038 if (accessMask != 0) {
2039 // TODO: Verify against Valid Use section spec
2040 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2041 DRAWSTATE_INVALID_BARRIER, "DS",
2042 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2043 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
2044 }
2045 break;
2046 }
2047 case VK_IMAGE_LAYOUT_GENERAL:
2048 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002049 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002050 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002051}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002052
2053// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002054// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2055// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002056bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002057 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2058 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002059 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2060 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2061 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2062 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002063 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
2064 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
2065 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
2066 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002067 }
2068 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002069 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002070}
2071
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002072bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2073 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002074 bool skip = false;
2075
2076 // Track when we're observing the first use of an attachment
2077 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2078 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2079 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
2080 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2081 auto attach_index = subpass.pColorAttachments[j].attachment;
2082 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2083
2084 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002085 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
2086 // This is ideal.
2087 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002088
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002089 case VK_IMAGE_LAYOUT_GENERAL:
2090 // May not be optimal; TODO: reconsider this warning based on other constraints?
2091 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2092 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2093 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2094 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002095
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002096 default:
2097 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2098 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2099 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2100 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002101 }
2102
2103 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002104 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2105 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002106 }
2107 attach_first_use[attach_index] = false;
2108 }
2109 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2110 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002111 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2112 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2113 // These are ideal.
2114 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002115
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002116 case VK_IMAGE_LAYOUT_GENERAL:
2117 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2118 // doing a bunch of transitions.
2119 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2120 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2121 "GENERAL layout for depth attachment may not give optimal performance.");
2122 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002123
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002124 default:
2125 // No other layouts are acceptable
2126 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2127 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2128 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2129 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2130 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002131 }
2132
2133 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2134 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002135 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2136 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002137 }
2138 attach_first_use[attach_index] = false;
2139 }
2140 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2141 auto attach_index = subpass.pInputAttachments[j].attachment;
2142 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2143
2144 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002145 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2146 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2147 // These are ideal.
2148 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002149
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002150 case VK_IMAGE_LAYOUT_GENERAL:
2151 // May not be optimal. TODO: reconsider this warning based on other constraints.
2152 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2153 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2154 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2155 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002156
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002157 default:
2158 // No other layouts are acceptable
2159 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2160 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2161 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2162 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002163 }
2164
2165 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002166 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2167 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002168 }
2169 attach_first_use[attach_index] = false;
2170 }
2171 }
2172 return skip;
2173}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002174
2175// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002176bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2177 VkDeviceSize offset, VkDeviceSize end_offset) {
2178 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2179 bool skip = false;
2180 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2181 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002182 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2183 for (auto image_handle : mem_info->bound_images) {
2184 auto img_it = mem_info->bound_ranges.find(image_handle);
2185 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002186 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002187 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002188 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002189 for (auto layout : layouts) {
2190 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Dave Houltoneba86e22017-03-02 14:56:23 -07002191 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
2192 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Michael Lentinec174b932017-02-10 14:57:15 -06002193 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2194 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002195 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002196 }
2197 }
2198 }
2199 }
2200 }
2201 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002202 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002203}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002204
2205// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2206// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002207static bool validate_usage_flags(layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002208 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2209 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002210 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002211
2212 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002213 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002214 if (strict) {
2215 correct_usage = ((actual & desired) == desired);
2216 } else {
2217 correct_usage = ((actual & desired) != 0);
2218 }
2219 if (!correct_usage) {
2220 if (msgCode == -1) {
2221 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltoneba86e22017-03-02 14:56:23 -07002222 skip = log_msg(
2223 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2224 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation.",
2225 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002226 } else {
2227 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002228 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2229 "Invalid usage flag for %s 0x%" PRIxLEAST64
2230 " used by %s. In this case, %s should have %s set during creation. %s",
2231 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002232 }
2233 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002234 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002235}
2236
2237// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2238// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002239bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002240 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002241 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002242 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2243 msgCode, "image", func_name, usage_string);
2244}
2245
2246// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2247// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002248bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002249 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002250 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002251 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2252 msgCode, "buffer", func_name, usage_string);
2253}
2254
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002255bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002256 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002257 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2258
Mark Lobodzinski96210742017-02-09 10:33:46 -07002259 // TODO: Add check for VALIDATION_ERROR_00658
Mark Lobodzinski96210742017-02-09 10:33:46 -07002260 // TODO: Add check for VALIDATION_ERROR_00667
2261 // TODO: Add check for VALIDATION_ERROR_00668
2262 // TODO: Add check for VALIDATION_ERROR_00669
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002263
2264 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
2265 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2266 VALIDATION_ERROR_00666, "DS",
2267 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
2268 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
2269 validation_error_map[VALIDATION_ERROR_00666]);
2270 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06002271
2272 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
2273 skip |=
2274 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2275 DRAWSTATE_INVALID_FEATURE, "DS",
2276 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
2277 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
2278 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06002279
2280 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
2281 skip |=
2282 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2283 DRAWSTATE_INVALID_FEATURE, "DS",
2284 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
2285 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
2286 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07002287 return skip;
2288}
2289
2290void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2291 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2292 GetBufferMap(device_data)
2293 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2294}
2295
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002296bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2297 bool skip = false;
2298 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002299 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2300 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002301 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002302 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2303 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002304 skip |= ValidateBufferUsageFlags(
2305 device_data, buffer_state, VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002306 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2307 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002308 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002309}
2310
2311void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2312 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2313}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002314
2315// For the given format verify that the aspect masks make sense
2316bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2317 const char *func_name) {
2318 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2319 bool skip = false;
2320 if (vk_format_is_color(format)) {
2321 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2322 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2323 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2324 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2325 validation_error_map[VALIDATION_ERROR_00741]);
2326 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2327 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2328 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2329 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2330 validation_error_map[VALIDATION_ERROR_00741]);
2331 }
2332 } else if (vk_format_is_depth_and_stencil(format)) {
2333 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2334 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2335 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2336 "%s: Depth/stencil image formats must have "
2337 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2338 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2339 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2340 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
2341 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2342 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2343 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2344 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2345 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2346 }
2347 } else if (vk_format_is_depth_only(format)) {
2348 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2350 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2351 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2352 validation_error_map[VALIDATION_ERROR_00741]);
2353 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2354 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2355 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2356 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2357 validation_error_map[VALIDATION_ERROR_00741]);
2358 }
2359 } else if (vk_format_is_stencil_only(format)) {
2360 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2361 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2362 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2363 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2364 validation_error_map[VALIDATION_ERROR_00741]);
2365 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2366 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2367 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2368 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2369 validation_error_map[VALIDATION_ERROR_00741]);
2370 }
2371 }
2372 return skip;
2373}
2374
2375bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2376 const char *func_name) {
2377 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2378 bool skip = false;
2379 if (subresourceRange.levelCount == 0) {
2380 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2381 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2382 validation_error_map[VALIDATION_ERROR_00768]);
2383 }
2384 if (subresourceRange.layerCount == 0) {
2385 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2386 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2387 validation_error_map[VALIDATION_ERROR_00769]);
2388 }
2389 return skip;
2390}
2391
2392bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2393 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2394 bool skip = false;
2395 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2396 if (image_state) {
2397 skip |= ValidateImageUsageFlags(
2398 device_data, image_state,
2399 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2400 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2401 false, -1, "vkCreateImageView()",
2402 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2403 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2404 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2405 // Checks imported from image layer
2406 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2407 std::stringstream ss;
2408 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2409 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2410 skip |=
2411 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2412 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2413 }
2414 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2415 std::stringstream ss;
2416 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2417 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2418 skip |=
2419 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2420 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2421 }
2422 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2423 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2424
2425 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2426 VkFormat image_format = image_state->createInfo.format;
2427 VkFormat view_format = create_info->format;
2428 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2429
2430 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2431 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2432 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2433 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2434 std::stringstream ss;
2435 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2436 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2437 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2438 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
2439 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2440 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2441 validation_error_map[VALIDATION_ERROR_02171]);
2442 }
2443 } else {
2444 // Format MUST be IDENTICAL to the format the image was created with
2445 if (image_format != view_format) {
2446 std::stringstream ss;
2447 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2448 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2449 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
2450 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2451 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2452 validation_error_map[VALIDATION_ERROR_02172]);
2453 }
2454 }
2455
2456 // Validate correct image aspect bits for desired formats and format consistency
2457 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2458 }
2459 return skip;
2460}
2461
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002462void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2463 auto image_view_map = GetImageViewMap(device_data);
2464 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2465
2466 auto image_state = GetImageState(device_data, create_info->image);
Petr Kraus87d3d112017-03-12 14:00:50 +01002467 auto& sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002468 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002469}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002470
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002471bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2472 BUFFER_STATE *dst_buffer_state) {
2473 bool skip = false;
2474 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2475 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2476 // Validate that SRC & DST buffers have correct usage flags set
2477 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2478 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2479 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2480 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2481 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2482 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2483 return skip;
2484}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002485
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002486void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2487 BUFFER_STATE *dst_buffer_state) {
2488 // Update bindings between buffers and cmd buffer
2489 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2490 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2491
2492 std::function<bool()> function = [=]() {
2493 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2494 };
2495 cb_node->validate_functions.push_back(function);
2496 function = [=]() {
2497 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2498 return false;
2499 };
2500 cb_node->validate_functions.push_back(function);
2501 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2502}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002503
2504static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2505 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2506 bool skip = false;
2507 auto buffer_state = GetBufferState(device_data, buffer);
2508 if (!buffer_state) {
2509 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2510 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2511 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2512 } else {
2513 if (buffer_state->in_use.load()) {
2514 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2515 __LINE__, VALIDATION_ERROR_00676, "DS",
2516 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2517 validation_error_map[VALIDATION_ERROR_00676]);
2518 }
2519 }
2520 return skip;
2521}
2522
2523bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2524 VK_OBJECT *obj_struct) {
2525 *image_view_state = GetImageViewState(device_data, image_view);
2526 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2527 if (GetDisables(device_data)->destroy_image_view) return false;
2528 bool skip = false;
2529 if (*image_view_state) {
2530 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2531 }
2532 return skip;
2533}
2534
2535void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2536 VK_OBJECT obj_struct) {
2537 // Any bound cmd buffers are now invalid
2538 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2539 (*GetImageViewMap(device_data)).erase(image_view);
2540}
2541
2542bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2543 *buffer_state = GetBufferState(device_data, buffer);
2544 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2545 if (GetDisables(device_data)->destroy_buffer) return false;
2546 bool skip = false;
2547 if (*buffer_state) {
2548 skip |= validateIdleBuffer(device_data, buffer);
2549 }
2550 return skip;
2551}
2552
2553void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2554 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2555 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2556 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2557 if (mem_info) {
2558 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2559 }
2560 }
2561 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2562 GetBufferMap(device_data)->erase(buffer_state->buffer);
2563}
2564
2565bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2566 VK_OBJECT *obj_struct) {
2567 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2568 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2569 if (GetDisables(device_data)->destroy_buffer_view) return false;
2570 bool skip = false;
2571 if (*buffer_view_state) {
2572 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2573 }
2574 return skip;
2575}
2576
2577void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2578 VK_OBJECT obj_struct) {
2579 // Any bound cmd buffers are now invalid
2580 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2581 GetBufferViewMap(device_data)->erase(buffer_view);
2582}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002583
2584bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2585 bool skip = false;
2586 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
2587 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2588 // Validate that DST buffer has correct usage flags set
2589 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2590 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2591 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2592 return skip;
2593}
2594
2595void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2596 std::function<bool()> function = [=]() {
2597 SetBufferMemoryValid(device_data, buffer_state, true);
2598 return false;
2599 };
2600 cb_node->validate_functions.push_back(function);
2601 // Update bindings between buffer and cmd buffer
2602 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2603 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2604}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002605
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002606bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2607 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002608 bool skip = false;
2609
2610 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002611 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
2612 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002613 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002614 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
2615 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2616 "must be 0 and 1, respectively. %s",
2617 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2618 validation_error_map[VALIDATION_ERROR_01746]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002619 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002620 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002621
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002622 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
2623 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002624 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002625 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
2626 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2627 "must be 0 and 1, respectively. %s",
2628 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2629 validation_error_map[VALIDATION_ERROR_01747]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002630 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002631 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002632
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002633 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2634 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2635 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2636 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
2637 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2638 "%d. For 3D images these must be 0 and 1, respectively. %s",
2639 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
2640 validation_error_map[VALIDATION_ERROR_01281]);
2641 }
2642 }
2643
2644 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2645 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
2646 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2647 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
2648 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2649 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2650 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
2651 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2652 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2653 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2654 }
2655
2656 // BufferOffset must be a multiple of 4
2657 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2658 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2659 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
2660 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2661 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2662 }
2663
2664 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2665 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2666 skip |= log_msg(
2667 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2668 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
2669 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2670 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2671 validation_error_map[VALIDATION_ERROR_01265]);
2672 }
2673
2674 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2675 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2676 skip |= log_msg(
2677 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2678 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
2679 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2680 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2681 validation_error_map[VALIDATION_ERROR_01266]);
2682 }
2683
2684 // subresource aspectMask must have exactly 1 bit set
2685 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2686 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2687 if (aspect_mask_bits.count() != 1) {
2688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2689 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
2690 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2691 validation_error_map[VALIDATION_ERROR_01280]);
2692 }
2693
2694 // image subresource aspect bit must match format
2695 if (((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT)) &&
2696 (!vk_format_is_color(image_state->createInfo.format))) ||
2697 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT)) &&
2698 (!vk_format_has_depth(image_state->createInfo.format))) ||
2699 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2700 (!vk_format_has_stencil(image_state->createInfo.format)))) {
2701 skip |= log_msg(
2702 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2703 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
2704 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
2705 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
2706 validation_error_map[VALIDATION_ERROR_01279]);
2707 }
2708
2709 // Checks that apply only to compressed images
2710 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2711 // reserves a place for these compressed image checks. This block of code could move there once the image
2712 // stuff is moved into core validation.
2713 if (vk_format_is_compressed(image_state->createInfo.format)) {
2714 auto block_size = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2715
2716 // BufferRowLength must be a multiple of block width
2717 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002718 skip |= log_msg(
2719 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002720 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
2721 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2722 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002723 }
2724
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002725 // BufferRowHeight must be a multiple of block height
2726 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002727 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002728 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
2729 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2730 "height (%d). %s.",
2731 function, i, pRegions[i].bufferImageHeight, block_size.height,
2732 validation_error_map[VALIDATION_ERROR_01272]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002733 }
2734
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002735 // image offsets must be multiples of block dimensions
2736 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
Dave Houlton75967fc2017-03-06 17:21:16 -07002737 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
2738 (vk_safe_modulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002739 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2740 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
2741 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2742 "width & height (%d, %d). %s.",
2743 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2744 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002745 }
2746
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002747 // bufferOffset must be a multiple of block size (linear bytes)
2748 size_t block_size_in_bytes = vk_format_get_size(image_state->createInfo.format);
2749 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
2750 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2751 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01274, "IMAGE",
2752 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
2753 ") must be a multiple of the compressed image's texel block "
2754 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
2755 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2756 validation_error_map[VALIDATION_ERROR_01274]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002757 }
Dave Houlton67e9b532017-03-02 17:00:10 -07002758
2759 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07002760 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton67e9b532017-03-02 17:00:10 -07002761 if ((vk_safe_modulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002762 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
2763 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2764 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01275, "IMAGE",
2765 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
2766 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
2767 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
2768 mip_extent.width, validation_error_map[VALIDATION_ERROR_01275]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002769 }
2770
2771 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
2772 if ((vk_safe_modulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002773 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
2774 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2775 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01276, "IMAGE",
2776 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
2777 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
2778 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
2779 mip_extent.height, validation_error_map[VALIDATION_ERROR_01276]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002780 }
2781
2782 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
2783 if ((vk_safe_modulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002784 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
2785 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2786 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01277, "IMAGE",
2787 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
2788 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
2789 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
2790 mip_extent.depth, validation_error_map[VALIDATION_ERROR_01277]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002791 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002792 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002793 }
2794
2795 return skip;
2796}
2797
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002798static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
2799 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002800 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002801 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002802
2803 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002804 VkExtent3D extent = pRegions[i].imageExtent;
2805 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002806
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002807 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
2808 {
2809 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2810 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
2811 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
2812 extent.height, extent.depth);
2813 }
2814
2815 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
2816
2817 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002818 if (vk_format_is_compressed(image_info->format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002819 auto block_extent = vk_format_compressed_texel_block_extents(image_info->format);
2820 if (image_extent.width % block_extent.width) {
2821 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
2822 }
2823 if (image_extent.height % block_extent.height) {
2824 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
2825 }
2826 if (image_extent.depth % block_extent.depth) {
2827 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
2828 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002829 }
2830
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002831 if (ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002832 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 -07002833 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002834 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002835 }
2836 }
2837
2838 return skip;
2839}
2840
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002841static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2842 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2843 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2844 bool skip = false;
2845
2846 VkDeviceSize buffer_size = buff_state->createInfo.size;
2847
2848 for (uint32_t i = 0; i < regionCount; i++) {
2849 VkExtent3D copy_extent = pRegions[i].imageExtent;
2850
2851 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2852 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2853 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2854
Dave Houltonf3229d52017-02-21 15:59:08 -07002855 // Handle special buffer packing rules for specific depth/stencil formats
2856 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2857 unit_size = vk_format_get_size(VK_FORMAT_S8_UINT);
2858 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2859 switch (image_state->createInfo.format) {
2860 case VK_FORMAT_D16_UNORM_S8_UINT:
2861 unit_size = vk_format_get_size(VK_FORMAT_D16_UNORM);
2862 break;
2863 case VK_FORMAT_D32_SFLOAT_S8_UINT:
2864 unit_size = vk_format_get_size(VK_FORMAT_D32_SFLOAT);
2865 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002866 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07002867 case VK_FORMAT_D24_UNORM_S8_UINT:
2868 unit_size = 4;
2869 break;
2870 default:
2871 break;
2872 }
2873 }
2874
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002875 if (vk_format_is_compressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002876 // Switch to texel block units, rounding up for any partially-used blocks
2877 auto block_dim = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2878 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
2879 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
2880
2881 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
2882 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
2883 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002884 }
2885
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002886 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
2887 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2888 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
2889 // TODO: Issure warning here? Already warned in ValidateImageBounds()...
2890 } else {
2891 // Calculate buffer offset of final copied byte, + 1.
2892 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
2893 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2894 max_buffer_offset *= unit_size; // convert to bytes
2895 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002896
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002897 if (buffer_size < max_buffer_offset) {
2898 skip |=
2899 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2900 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
2901 i, buffer_size, validation_error_map[msg_code]);
2902 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002903 }
2904 }
2905
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002906 return skip;
2907}
2908
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002909bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002910 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002911 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002912 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2913 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2914
2915 // Validate command buffer state
2916 if (CB_RECORDING != cb_node->state) {
2917 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2918 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2919 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2920 validation_error_map[VALIDATION_ERROR_01258]);
2921 } else {
2922 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2923 }
2924
2925 // Command pool must support graphics, compute, or transfer operations
2926 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2927
2928 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2929 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2930 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2931 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2932 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2933 "or transfer capabilities. %s.",
2934 validation_error_map[VALIDATION_ERROR_01259]);
2935 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002936 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002937 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002938 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002939 VALIDATION_ERROR_01246);
2940
2941 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2942 VALIDATION_ERROR_01249);
2943 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002944 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002945
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002946 // Validate that SRC image & DST buffer have correct usage flags set
2947 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2948 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002949 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002950 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002951 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
2952 for (uint32_t i = 0; i < regionCount; ++i) {
2953 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, pRegions[i].imageSubresource, srcImageLayout,
2954 VALIDATION_ERROR_01251);
2955 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
2956 "CmdCopyImageToBuffer");
2957 }
2958 return skip;
2959}
2960
2961void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002962 BUFFER_STATE *dst_buffer_state) {
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002963 // Update bindings between buffer/image and cmd buffer
2964 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002965 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002966
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002967 std::function<bool()> function = [=]() {
2968 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
2969 };
2970 cb_node->validate_functions.push_back(function);
2971 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002972 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002973 return false;
2974 };
2975 cb_node->validate_functions.push_back(function);
2976
2977 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002978}
2979
2980bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002981 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002982 const VkBufferImageCopy *pRegions, const char *func_name) {
2983 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2984 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
2985
2986 // Validate command buffer state
2987 if (CB_RECORDING != cb_node->state) {
2988 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2989 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
2990 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
2991 validation_error_map[VALIDATION_ERROR_01240]);
2992 } else {
2993 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
2994 }
2995
2996 // Command pool must support graphics, compute, or transfer operations
2997 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2998 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2999 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3001 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
3002 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
3003 "or transfer capabilities. %s.",
3004 validation_error_map[VALIDATION_ERROR_01241]);
3005 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003006 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003007 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003008 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003009 VALIDATION_ERROR_01227);
3010 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
3011 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003012 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003013 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003014 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003015 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3016 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
3017 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003018 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
3019 for (uint32_t i = 0; i < regionCount; ++i) {
3020 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, pRegions[i].imageSubresource, dstImageLayout,
3021 VALIDATION_ERROR_01234);
3022 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
3023 "vkCmdCopyBufferToImage()");
3024 }
3025 return skip;
3026}
3027
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003028void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003029 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003030 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003031 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003032 std::function<bool()> function = [=]() {
3033 SetImageMemoryValid(device_data, dst_image_state, true);
3034 return false;
3035 };
3036 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003037 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003038 cb_node->validate_functions.push_back(function);
3039
3040 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003041}
Mike Weiblen672b58b2017-02-21 14:32:53 -07003042
3043bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
3044 const auto report_data = core_validation::GetReportData(device_data);
3045 bool skip = false;
3046 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
3047
3048 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
3049 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
3050 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
3051 if (aspect_mask_bits.count() != 1) {
3052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3053 VALIDATION_ERROR_00733, "IMAGE",
3054 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
3055 validation_error_map[VALIDATION_ERROR_00733]);
3056 }
3057
3058 IMAGE_STATE *image_entry = GetImageState(device_data, image);
3059 if (!image_entry) {
3060 return skip;
3061 }
3062
3063 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
3064 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
3065 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3066 __LINE__, VALIDATION_ERROR_00732, "IMAGE",
3067 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
3068 validation_error_map[VALIDATION_ERROR_00732]);
3069 }
3070
3071 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
3072 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
3073 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3074 __LINE__, VALIDATION_ERROR_00739, "IMAGE",
3075 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
3076 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
3077 }
3078
3079 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
3080 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
3081 skip |= log_msg(
3082 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
3083 VALIDATION_ERROR_00740, "IMAGE", "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
3084 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
3085 }
3086
3087 // VU 00741: subresource's aspect must be compatible with image's format.
3088 const VkFormat img_format = image_entry->createInfo.format;
3089 if (vk_format_is_color(img_format)) {
3090 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
3091 skip |= log_msg(
3092 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
3093 VALIDATION_ERROR_00741, "IMAGE",
3094 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
3095 validation_error_map[VALIDATION_ERROR_00741]);
3096 }
3097 } else if (vk_format_is_depth_or_stencil(img_format)) {
3098 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
3099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3100 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
3101 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
3102 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
3103 validation_error_map[VALIDATION_ERROR_00741]);
3104 }
3105 }
3106 return skip;
3107}