blob: 632c0ba1fb53973ffe436b16f03d128e327bf8e7 [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
31
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070032#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070033
Tobin Ehlis58c884f2017-02-08 12:15:27 -070034void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070035 if (std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair) !=
36 pCB->imageSubresourceMap[imgpair.image].end()) {
37 pCB->imageLayoutMap[imgpair].layout = layout;
38 } else {
39 assert(imgpair.hasSubresource);
40 IMAGE_CMD_BUF_LAYOUT_NODE node;
41 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
42 node.initialLayout = layout;
43 }
44 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
45 }
46}
47template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070048void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070049 ImageSubresourcePair imgpair = {image, true, range};
50 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
51 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
53 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
54}
55
56template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070057void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070058 VkImageAspectFlags aspectMask) {
59 if (imgpair.subresource.aspectMask & aspectMask) {
60 imgpair.subresource.aspectMask = aspectMask;
61 SetLayout(device_data, pObject, imgpair, layout);
62 }
63}
64
Tony Barbourdf013b92017-01-25 12:53:48 -070065// Set the layout in supplied map
66void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
67 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 Barbourdf013b92017-01-25 12:53:48 -0700179bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
180 const VkImageAspectFlags aspectMask) {
181 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;
191 }
192
193// find layout in supplied map
194bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout) {
195 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
196 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
197 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
198 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
199 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
200 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
201 imgpair = {imgpair.image, false, VkImageSubresource()};
202 auto imgsubIt = imageLayoutMap.find(imgpair);
203 if (imgsubIt == imageLayoutMap.end()) return false;
204 layout = imgsubIt->second.layout;
205 }
206 return true;
207}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208
209// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700210void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700211 VkImage &image = imgpair.image;
212 (*core_validation::GetImageLayoutMap(device_data))[imgpair].layout = layout;
213 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
214 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
215 if (subresource == image_subresources.end()) {
216 image_subresources.push_back(imgpair);
217 }
218}
219
220// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700221void 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 -0700222 pCB->imageLayoutMap[imgpair] = node;
223 auto subresource =
224 std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair);
225 if (subresource == pCB->imageSubresourceMap[imgpair.image].end()) {
226 pCB->imageSubresourceMap[imgpair.image].push_back(imgpair);
227 }
228}
229
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700230void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImageView imageView, const VkImageLayout &layout) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700231 auto view_state = GetImageViewState(device_data, imageView);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700232 assert(view_state);
233 auto image = view_state->create_info.image;
234 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
235 // TODO: Do not iterate over every possibility - consolidate where possible
236 for (uint32_t j = 0; j < subRange.levelCount; j++) {
237 uint32_t level = subRange.baseMipLevel + j;
238 for (uint32_t k = 0; k < subRange.layerCount; k++) {
239 uint32_t layer = subRange.baseArrayLayer + k;
240 VkImageSubresource sub = {subRange.aspectMask, level, layer};
241 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
242 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
243 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
244 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
245 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
246 }
247 }
248 SetLayout(device_data, pCB, image, sub, layout);
249 }
250 }
251}
252
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700253bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700254 const VkRenderPassBeginInfo *pRenderPassBegin,
255 const FRAMEBUFFER_STATE *framebuffer_state) {
256 bool skip_call = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700257 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700258 auto const &framebufferInfo = framebuffer_state->createInfo;
259 const auto report_data = core_validation::GetReportData(device_data);
260 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
261 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
262 DRAWSTATE_INVALID_RENDERPASS, "DS",
263 "You cannot start a render pass using a framebuffer "
264 "with a different number of attachments.");
265 }
266 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
267 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700268 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700269 assert(view_state);
270 const VkImage &image = view_state->create_info.image;
271 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
272 IMAGE_CMD_BUF_LAYOUT_NODE newNode = {pRenderPassInfo->pAttachments[i].initialLayout,
273 pRenderPassInfo->pAttachments[i].initialLayout};
274 // TODO: Do not iterate over every possibility - consolidate where possible
275 for (uint32_t j = 0; j < subRange.levelCount; j++) {
276 uint32_t level = subRange.baseMipLevel + j;
277 for (uint32_t k = 0; k < subRange.layerCount; k++) {
278 uint32_t layer = subRange.baseArrayLayer + k;
279 VkImageSubresource sub = {subRange.aspectMask, level, layer};
280 IMAGE_CMD_BUF_LAYOUT_NODE node;
281 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
282 SetLayout(device_data, pCB, image, sub, newNode);
283 continue;
284 }
285 if (newNode.layout != VK_IMAGE_LAYOUT_UNDEFINED && newNode.layout != node.layout) {
286 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
287 DRAWSTATE_INVALID_RENDERPASS, "DS",
288 "You cannot start a render pass using attachment %u "
289 "where the render pass initial layout is %s and the previous "
290 "known layout of the attachment is %s. The layouts must match, or "
291 "the render pass initial layout for the attachment must be "
292 "VK_IMAGE_LAYOUT_UNDEFINED",
293 i, string_VkImageLayout(newNode.layout), string_VkImageLayout(node.layout));
294 }
295 }
296 }
297 }
298 return skip_call;
299}
300
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700301void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700302 VkAttachmentReference ref) {
303 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
304 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
305 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
306 }
307}
308
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700309void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
310 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700311 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700312 if (!renderPass) return;
313
314 if (framebuffer_state) {
315 auto const &subpass = renderPass->createInfo.pSubpasses[subpass_index];
316 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
317 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
318 }
319 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
320 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
321 }
322 if (subpass.pDepthStencilAttachment) {
323 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
324 }
325 }
326}
327
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700328bool TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
329 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700330 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
331 return false;
332 }
333 VkImageSubresource sub = {aspect, level, layer};
334 IMAGE_CMD_BUF_LAYOUT_NODE node;
335 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
336 SetLayout(device_data, pCB, mem_barrier->image, sub,
337 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
338 return false;
339 }
340 bool skip = false;
341 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
342 // TODO: Set memory invalid which is in mem_tracker currently
343 } else if (node.layout != mem_barrier->oldLayout) {
344 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0,
345 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
346 "You cannot transition the layout of aspect %d from %s when current layout is %s.", aspect,
347 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
348 }
349 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
350 return skip;
351}
352
353// TODO: Separate validation and layout state updates
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700354bool TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700355 const VkImageMemoryBarrier *pImgMemBarriers) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700356 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700357 bool skip = false;
358 uint32_t levelCount = 0;
359 uint32_t layerCount = 0;
360
361 for (uint32_t i = 0; i < memBarrierCount; ++i) {
362 auto mem_barrier = &pImgMemBarriers[i];
363 if (!mem_barrier) continue;
364 // TODO: Do not iterate over every possibility - consolidate where possible
365 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700366 GetImageState(device_data, mem_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700367
368 for (uint32_t j = 0; j < levelCount; j++) {
369 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
370 for (uint32_t k = 0; k < layerCount; k++) {
371 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
372 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
373 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
374 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
375 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
376 }
377 }
378 }
379 return skip;
380}
381
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700382bool VerifySourceImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage srcImage, VkImageSubresourceLayers subLayers,
383 VkImageLayout srcImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700384 const auto report_data = core_validation::GetReportData(device_data);
385 bool skip_call = false;
386
387 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
388 uint32_t layer = i + subLayers.baseArrayLayer;
389 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
390 IMAGE_CMD_BUF_LAYOUT_NODE node;
391 if (!FindCmdBufLayout(device_data, cb_node, srcImage, sub, node)) {
392 SetLayout(device_data, cb_node, srcImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(srcImageLayout, srcImageLayout));
393 continue;
394 }
395 if (node.layout != srcImageLayout) {
396 // TODO: Improve log message in the next pass
397 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
398 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
399 "Cannot copy from an image whose source layout is %s "
400 "and doesn't match the current layout %s.",
401 string_VkImageLayout(srcImageLayout), string_VkImageLayout(node.layout));
402 }
403 }
404 if (srcImageLayout != VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) {
405 if (srcImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
406 // 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 -0700407 auto image_state = GetImageState(device_data, srcImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700408 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
409 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
410 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
411 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
412 "Layout for input image should be TRANSFER_SRC_OPTIMAL instead of GENERAL.");
413 }
414 } else {
415 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
416 "DS", "Layout for input image is %s but can only be TRANSFER_SRC_OPTIMAL or GENERAL. %s",
417 string_VkImageLayout(srcImageLayout), validation_error_map[msgCode]);
418 }
419 }
420 return skip_call;
421}
422
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700423bool VerifyDestImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage destImage, VkImageSubresourceLayers subLayers,
424 VkImageLayout destImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700425 const auto report_data = core_validation::GetReportData(device_data);
426 bool skip_call = false;
427
428 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
429 uint32_t layer = i + subLayers.baseArrayLayer;
430 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
431 IMAGE_CMD_BUF_LAYOUT_NODE node;
432 if (!FindCmdBufLayout(device_data, cb_node, destImage, sub, node)) {
433 SetLayout(device_data, cb_node, destImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(destImageLayout, destImageLayout));
434 continue;
435 }
436 if (node.layout != destImageLayout) {
437 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
438 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
439 "Cannot copy from an image whose dest layout is %s and "
440 "doesn't match the current layout %s.",
441 string_VkImageLayout(destImageLayout), string_VkImageLayout(node.layout));
442 }
443 }
444 if (destImageLayout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
445 if (destImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700446 auto image_state = GetImageState(device_data, destImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700447 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
448 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
449 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
450 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
451 "Layout for output image should be TRANSFER_DST_OPTIMAL instead of GENERAL.");
452 }
453 } else {
454 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
455 "DS", "Layout for output image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s",
456 string_VkImageLayout(destImageLayout), validation_error_map[msgCode]);
457 }
458 }
459 return skip_call;
460}
461
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700462void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
463 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700464 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700465 if (!renderPass) return;
466
467 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
468 if (framebuffer_state) {
469 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
470 auto image_view = framebuffer_state->createInfo.pAttachments[i];
471 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
472 }
473 }
474}
475
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700476bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700477 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
478 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700479 const debug_report_data *report_data = core_validation::GetReportData(device_data);
480
481 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700482 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700483
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700484 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700485 std::stringstream ss;
486 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
487 skip_call |=
488 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
489 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
490 }
491
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700492 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700493 std::stringstream ss;
494 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
495 skip_call |=
496 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
497 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
498 }
499
500 // Validate that format supports usage as color attachment
501 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
502 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700503 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700504 std::stringstream ss;
505 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
506 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
507 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
508 __LINE__, VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(),
509 validation_error_map[VALIDATION_ERROR_02158]);
510 }
511 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700512 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700513 std::stringstream ss;
514 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
515 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
516 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
517 __LINE__, VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(),
518 validation_error_map[VALIDATION_ERROR_02153]);
519 }
520 }
521 // Validate that format supports usage as depth/stencil attachment
522 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
523 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700524 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700525 std::stringstream ss;
526 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
527 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
528 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
529 __LINE__, VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(),
530 validation_error_map[VALIDATION_ERROR_02159]);
531 }
532 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700533 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700534 std::stringstream ss;
535 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
536 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
537 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
538 __LINE__, VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(),
539 validation_error_map[VALIDATION_ERROR_02154]);
540 }
541 }
542 } else {
543 skip_call |=
544 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
545 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
546 validation_error_map[VALIDATION_ERROR_00715]);
547 }
548
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700549 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
550 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700551
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700552 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700553 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
554
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700555 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
556 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
557 VALIDATION_ERROR_00716, "Image",
558 "CreateImage extent is 0 for at least one required dimension for image: "
559 "Width = %d Height = %d Depth = %d. %s",
560 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
561 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700562 }
563
564 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
565 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700566 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
567 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
568 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700569 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
570 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
571 "CreateImage extents exceed allowable limits for format: "
572 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
573 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700574 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
575 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700576 }
577
578 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
579 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
580 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
581 (uint64_t)imageGranularity) &
582 ~(uint64_t)imageGranularity;
583
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700584 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700585 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
586 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
587 "CreateImage resource size exceeds allowable maximum "
588 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700589 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700590 }
591
592 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700593 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700594 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
595 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
596 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700597 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700598 }
599
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700600 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700601 skip_call |= log_msg(
602 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
603 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700604 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700605 }
606
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700607 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700608 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
609 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700610 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700611 validation_error_map[VALIDATION_ERROR_02138]);
612 }
613
614 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
615 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
616 VALIDATION_ERROR_00731, "Image",
617 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
618 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
619 validation_error_map[VALIDATION_ERROR_00731]);
620 }
621
622 return skip_call;
623}
624
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700625void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700626 IMAGE_LAYOUT_NODE image_state;
627 image_state.layout = pCreateInfo->initialLayout;
628 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700629 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 -0700630 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700631 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
632 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700633}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700634
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700635bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700636 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700637 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700638 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
639 if (disabled->destroy_image) return false;
640 bool skip = false;
641 if (*image_state) {
642 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
643 }
644 return skip;
645}
646
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700647void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700648 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
649 // Clean up memory mapping, bindings and range references for image
650 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700651 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700652 if (mem_info) {
653 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
654 }
655 }
656 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
657 // Remove image from imageMap
658 core_validation::GetImageMap(device_data)->erase(image);
659 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
660 core_validation::GetImageSubresourceMap(device_data);
661
662 const auto &sub_entry = imageSubresourceMap->find(image);
663 if (sub_entry != imageSubresourceMap->end()) {
664 for (const auto &pair : sub_entry->second) {
665 core_validation::GetImageLayoutMap(device_data)->erase(pair);
666 }
667 imageSubresourceMap->erase(sub_entry);
668 }
669}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700670
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700671bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700672 bool skip = false;
673 const debug_report_data *report_data = core_validation::GetReportData(device_data);
674
675 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
676 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
677 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
678 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
679 }
680
681 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
682 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
683 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
684 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
685 validation_error_map[VALIDATION_ERROR_01088]);
686 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
687 char const str[] = "vkCmdClearColorImage called with compressed image.";
688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
689 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
690 validation_error_map[VALIDATION_ERROR_01088]);
691 }
692
693 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
694 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
695 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
696 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
697 validation_error_map[VALIDATION_ERROR_01084]);
698 }
699 return skip;
700}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700701
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700702void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700703 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
704 // internal state to the actual values.
705 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
706 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
707 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700708
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700709 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
710 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700711 }
712}
713
714// 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 -0700715void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
716 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700717 *levels = range.levelCount;
718 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700719 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
720 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
721 }
722 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
723 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700724 }
725}
726
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700727bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700728 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
729 bool skip = false;
730 const debug_report_data *report_data = core_validation::GetReportData(device_data);
731
732 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700733 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700734
735 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
736 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700737 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
738 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
739 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
740 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
741 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
742 }
743 } else {
744 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
745 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
746 error_code = VALIDATION_ERROR_01101;
747 } else {
748 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
749 }
750 skip |=
751 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, error_code, "DS",
752 "%s: Layout for cleared image is %s but can only be "
753 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
754 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
755 }
756 }
757
758 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
759 uint32_t level = level_index + resolved_range.baseMipLevel;
760 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
761 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
762 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
763 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700764 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700765 if (node.layout != dest_image_layout) {
766 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
767 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
768 error_code = VALIDATION_ERROR_01100;
769 } else {
770 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
771 }
772 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
773 __LINE__, error_code, "DS",
774 "%s: Cannot clear an image whose layout is %s and "
775 "doesn't match the current layout %s. %s",
776 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
777 validation_error_map[error_code]);
778 }
779 }
780 }
781 }
782
783 return skip;
784}
785
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700786void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
787 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700788 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700789 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700790
791 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
792 uint32_t level = level_index + resolved_range.baseMipLevel;
793 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
794 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
795 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
796 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700797 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
798 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 -0700799 }
800 }
801 }
802}
803
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700804bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700805 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
806 bool skip = false;
807 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700808 auto cb_node = GetCBNode(dev_data, commandBuffer);
809 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700810 if (cb_node && image_state) {
811 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
812 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
813 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
814 for (uint32_t i = 0; i < rangeCount; ++i) {
815 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700816 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700817 }
818 }
819 return skip;
820}
821
822// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700823void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
824 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700825 auto cb_node = GetCBNode(dev_data, commandBuffer);
826 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700827 if (cb_node && image_state) {
828 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
829 std::function<bool()> function = [=]() {
830 SetImageMemoryValid(dev_data, image_state, true);
831 return false;
832 };
833 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700834 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700835 for (uint32_t i = 0; i < rangeCount; ++i) {
836 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
837 }
838 }
839}
840
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700841bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
842 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700843 const VkImageSubresourceRange *pRanges) {
844 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700845 const debug_report_data *report_data = core_validation::GetReportData(device_data);
846
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700847 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700848 auto cb_node = GetCBNode(device_data, commandBuffer);
849 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700850 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700851 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
852 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
853 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700854 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700855 skip |=
856 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700857 // Image aspect must be depth or stencil or both
858 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
859 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
860 char const str[] =
861 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
862 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
863 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
864 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
865 }
866 }
867 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
868 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
869 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
870 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
871 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700872 }
873 }
874 return skip;
875}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -0700876
877// Returns true if [x, xoffset] and [y, yoffset] overlap
878static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
879 bool result = false;
880 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
881 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
882
883 if (intersection_max > intersection_min) {
884 result = true;
885 }
886 return result;
887}
888
889// Returns true if two VkImageCopy structures overlap
890static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
891 bool result = false;
892 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
893 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
894 dst->dstSubresource.layerCount))) {
895 result = true;
896 switch (type) {
897 case VK_IMAGE_TYPE_3D:
898 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
899 // Intentionally fall through to 2D case
900 case VK_IMAGE_TYPE_2D:
901 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
902 // Intentionally fall through to 1D case
903 case VK_IMAGE_TYPE_1D:
904 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
905 break;
906 default:
907 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
908 assert(false);
909 }
910 }
911 return result;
912}
913
914// Returns true if offset and extent exceed image extents
915static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const IMAGE_STATE *image_state) {
916 bool result = false;
917 // Extents/depths cannot be negative but checks left in for clarity
918 switch (image_state->createInfo.imageType) {
919 case VK_IMAGE_TYPE_3D: // Validate z and depth
920 if ((offset->z + extent->depth > image_state->createInfo.extent.depth) || (offset->z < 0) ||
921 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
922 result = true;
923 }
924 // Intentionally fall through to 2D case to check height
925 case VK_IMAGE_TYPE_2D: // Validate y and height
926 if ((offset->y + extent->height > image_state->createInfo.extent.height) || (offset->y < 0) ||
927 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
928 result = true;
929 }
930 // Intentionally fall through to 1D case to check width
931 case VK_IMAGE_TYPE_1D: // Validate x and width
932 if ((offset->x + extent->width > image_state->createInfo.extent.width) || (offset->x < 0) ||
933 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
934 result = true;
935 }
936 break;
937 default:
938 assert(false);
939 }
940 return result;
941}
942
Mark Lobodzinskiab9be282017-02-09 12:01:27 -0700943// Test if two VkExtent3D structs are equivalent
944static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
945 bool result = true;
946 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
947 (extent->depth != other_extent->depth)) {
948 result = false;
949 }
950 return result;
951}
952
953// Returns the image extent of a specific subresource.
954static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
955 const uint32_t mip = subresource->mipLevel;
956 VkExtent3D extent = img->createInfo.extent;
957 extent.width = std::max(1U, extent.width >> mip);
958 extent.height = std::max(1U, extent.height >> mip);
959 extent.depth = std::max(1U, extent.depth >> mip);
960 return extent;
961}
962
963// Test if the extent argument has all dimensions set to 0.
964static inline bool IsExtentZero(const VkExtent3D *extent) {
965 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
966}
967
968// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
969static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
970 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
971 VkExtent3D granularity = {0, 0, 0};
972 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
973 if (pPool) {
974 granularity =
975 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
976 if (vk_format_is_compressed(img->createInfo.format)) {
977 auto block_size = vk_format_compressed_block_size(img->createInfo.format);
978 granularity.width *= block_size.width;
979 granularity.height *= block_size.height;
980 }
981 }
982 return granularity;
983}
984
985// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
986static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
987 bool valid = true;
988 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
989 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
990 valid = false;
991 }
992 return valid;
993}
994
995// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
996static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
997 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
998 const debug_report_data *report_data = core_validation::GetReportData(device_data);
999 bool skip = false;
1000 VkExtent3D offset_extent = {};
1001 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1002 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1003 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
1004 if (IsExtentZero(granularity)) {
1005 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
1006 if (IsExtentZero(&offset_extent) == false) {
1007 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1008 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1009 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1010 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1011 function, i, member, offset->x, offset->y, offset->z);
1012 }
1013 } else {
1014 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1015 // integer multiples of the image transfer granularity.
1016 if (IsExtentAligned(&offset_extent, granularity) == false) {
1017 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1018 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1019 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1020 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1021 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1022 granularity->depth);
1023 }
1024 }
1025 return skip;
1026}
1027
1028// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1029static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1030 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1031 const uint32_t i, const char *function, const char *member) {
1032 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1033 bool skip = false;
1034 if (IsExtentZero(granularity)) {
1035 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1036 // subresource extent.
1037 if (IsExtentEqual(extent, subresource_extent) == false) {
1038 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1039 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1040 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1041 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1042 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1043 subresource_extent->height, subresource_extent->depth);
1044 }
1045 } else {
1046 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1047 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1048 // subresource extent dimensions.
1049 VkExtent3D offset_extent_sum = {};
1050 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1051 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1052 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1053 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1054 skip |=
1055 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1056 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1057 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1058 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1059 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1060 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1061 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1062 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1063 }
1064 }
1065 return skip;
1066}
1067
1068// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1069static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1070 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1071 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1072
1073 bool skip = false;
1074 if (vk_safe_modulo(value, granularity) != 0) {
1075 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1076 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1077 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1078 "transfer granularity width (%d).",
1079 function, i, member, value, granularity);
1080 }
1081 return skip;
1082}
1083
1084// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1085static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1086 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1087 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1088 bool skip = false;
1089 if (vk_safe_modulo(value, granularity) != 0) {
1090 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1091 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1092 "%s: pRegion[%d].%s (%" PRIdLEAST64
1093 ") must be an even integer multiple of this command buffer's queue family image transfer "
1094 "granularity width (%d).",
1095 function, i, member, value, granularity);
1096 }
1097 return skip;
1098}
1099
1100// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1101bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1102 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1103 const uint32_t i, const char *function) {
1104 bool skip = false;
1105 if (vk_format_is_compressed(img->createInfo.format) == true) {
1106 // TODO: Add granularity checking for compressed formats
1107
1108 // bufferRowLength must be a multiple of the compressed texel block width
1109 // bufferImageHeight must be a multiple of the compressed texel block height
1110 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1111 // bufferOffset must be a multiple of the compressed texel block size in bytes
1112 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1113 // must equal the image subresource width
1114 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1115 // must equal the image subresource height
1116 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1117 // must equal the image subresource depth
1118 } else {
1119 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1120 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1121 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1122 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1123 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1124 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1125 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1126 i, function, "imageExtent");
1127 }
1128 return skip;
1129}
1130
1131// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1132bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1133 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1134 const char *function) {
1135 bool skip = false;
1136 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1137 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1138 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1139 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1140 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1141 function, "extent");
1142 return skip;
1143}
1144
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001145bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001146 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1147 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001148 bool skip = false;
1149 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1150 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1151
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001152 for (uint32_t i = 0; i < region_count; i++) {
1153 if (regions[i].srcSubresource.layerCount == 0) {
1154 std::stringstream ss;
1155 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1156 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1157 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1158 ss.str().c_str());
1159 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001160
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001161 if (regions[i].dstSubresource.layerCount == 0) {
1162 std::stringstream ss;
1163 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1164 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1165 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1166 ss.str().c_str());
1167 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001168
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001169 // For each region the layerCount member of srcSubresource and dstSubresource must match
1170 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1171 std::stringstream ss;
1172 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1173 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1174 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1175 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1176 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001177
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001178 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1179 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1180 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1181 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1182 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1183 validation_error_map[VALIDATION_ERROR_01197]);
1184 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001185
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001186 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1187 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1188 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1189 std::stringstream ss;
1190 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1191 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1192 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1193 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1194 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001195
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001196 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1197 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1198 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1199 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1200 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1201 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1202 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1203 validation_error_map[VALIDATION_ERROR_01221]);
1204 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001205
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001206 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1207 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1208 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1209 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1210 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1211 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1212 std::stringstream ss;
1213 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1214 << "] baseArrayLayer was not zero or layerCount was not 1.";
1215 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1216 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1217 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1218 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001219
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001220 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1221 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1222 std::stringstream ss;
1223 ss << "vkCmdCopyImage: pRegions[" << i
1224 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1226 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1227 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1228 }
1229 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1230 std::stringstream ss;
1231 ss << "vkCmdCopyImage: pRegions[" << i
1232 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1233 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1234 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1235 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1236 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001237
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001238 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1239 // image was created
1240 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1241 src_image_state->createInfo.arrayLayers) {
1242 std::stringstream ss;
1243 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1244 << "] baseArrayLayer + layerCount is "
1245 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1246 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1247 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1248 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1249 }
1250 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1251 dst_image_state->createInfo.arrayLayers) {
1252 std::stringstream ss;
1253 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1254 << "] baseArrayLayer + layerCount is "
1255 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1256 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1257 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1258 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1259 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001260
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001261 // The source region specified by a given element of regions must be a region that is contained within srcImage
1262 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, src_image_state)) {
1263 std::stringstream ss;
1264 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1265 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1266 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1267 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1268 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001269
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001270 // The destination region specified by a given element of regions must be a region that is contained within dst_image
1271 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, dst_image_state)) {
1272 std::stringstream ss;
1273 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1275 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1276 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1277 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001278
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001279 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1280 // must not overlap in memory
1281 if (src_image_state->image == dst_image_state->image) {
1282 for (uint32_t j = 0; j < region_count; j++) {
1283 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1284 std::stringstream ss;
1285 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1286 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1287 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1288 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001289 }
1290 }
1291 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001292 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001293
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001294 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1295 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1296 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1297 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1298 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1299 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1300 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1301 skip |=
1302 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1303 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1304 }
1305 } else {
1306 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1307 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1308 if (srcSize != destSize) {
1309 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1310 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1311 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1312 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001313 }
1314 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001315
1316 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1317 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1318 // Validate that SRC & DST images have correct usage flags set
1319 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1320 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1321 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1322 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
1323 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1324 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1325 for (uint32_t i = 0; i < region_count; ++i) {
1326 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, regions[i].srcSubresource, src_image_layout,
1327 VALIDATION_ERROR_01180);
1328 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, regions[i].dstSubresource, dst_image_layout,
1329 VALIDATION_ERROR_01183);
1330 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1331 "vkCmdCopyImage()");
1332 }
1333
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001334 return skip;
1335}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001336
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001337void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1338 IMAGE_STATE *dst_image_state) {
1339 // Update bindings between images and cmd buffer
1340 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1341 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1342 std::function<bool()> function = [=]() {
1343 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()");
1344 };
1345 cb_node->validate_functions.push_back(function);
1346 function = [=]() {
1347 SetImageMemoryValid(device_data, dst_image_state, true);
1348 return false;
1349 };
1350 cb_node->validate_functions.push_back(function);
1351 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1352}
1353
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001354// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1355// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1356// to that same cmd buffer by separate thread are not changing state from underneath us
1357// Track the last cmd buffer touched by this thread
1358static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1359 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1360 if (pCB->drawCount[i]) return true;
1361 }
1362 return false;
1363}
1364
1365// Returns true if sub_rect is entirely contained within rect
1366static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1367 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1368 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1369 return false;
1370 return true;
1371}
1372
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001373bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1374 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001375 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001376 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1377
1378 bool skip = false;
1379 if (cb_node) {
1380 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001381 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001382 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1383 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1384 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1385 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
1386 // Can we make this warning more specific? I'd like to avoid triggering this test if we can tell it's a use that must
1387 // call CmdClearAttachments. Otherwise this seems more like a performance warning.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001388 skip |=
1389 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1390 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1391 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1392 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1393 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001394 }
1395 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1396 }
1397
1398 // Validate that attachment is in reference list of active subpass
1399 if (cb_node->activeRenderPass) {
1400 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1401 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001402 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001403
1404 for (uint32_t i = 0; i < attachmentCount; i++) {
1405 auto clear_desc = &pAttachments[i];
1406 VkImageView image_view = VK_NULL_HANDLE;
1407
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001408 if (0 == clear_desc->aspectMask) {
1409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1410 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
1411 validation_error_map[VALIDATION_ERROR_01128]);
1412 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1414 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
1415 validation_error_map[VALIDATION_ERROR_01126]);
1416 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001417 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001418 skip |=
1419 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1420 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01114, "DS",
1421 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1422 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001423 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1424 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001425 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1426 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1427 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1428 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001429 } else {
1430 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001431 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001432 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001433 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1434 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1435 char const str[] =
1436 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1437 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1438 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
1439 validation_error_map[VALIDATION_ERROR_01125]);
1440 }
1441 } else { // Must be depth and/or stencil
1442 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1443 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1444 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1445 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1446 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
1447 validation_error_map[VALIDATION_ERROR_01127]);
1448 }
1449 if (!subpass_desc->pDepthStencilAttachment ||
1450 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1451 skip |= log_msg(
1452 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1453 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1454 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001455 } else {
1456 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1457 }
1458 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001459 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001460 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001461 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001462 // The rectangular region specified by a given element of pRects must be contained within the render area of
1463 // the current render pass instance
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001464 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001465 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1466 __LINE__, VALIDATION_ERROR_01115, "DS",
1467 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1468 "the current render pass instance. %s",
1469 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001470 }
1471 // The layers specified by a given element of pRects must be contained within every attachment that
1472 // pAttachments refers to
1473 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1474 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1475 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1476 skip |=
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001477 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1478 __LINE__, VALIDATION_ERROR_01116, "DS",
1479 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1480 "pAttachment[%d]. %s",
1481 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001482 }
1483 }
1484 }
1485 }
1486 }
1487 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001488}
1489
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001490bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001491 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001492 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001493 bool skip = false;
1494 if (cb_node && src_image_state && dst_image_state) {
1495 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1496 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
1497 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1498 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001499
1500 // For each region, the number of layers in the image subresource should not be zero
1501 // For each region, src and dest image aspect must be color only
1502 for (uint32_t i = 0; i < regionCount; i++) {
1503 if (pRegions[i].srcSubresource.layerCount == 0) {
1504 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001505 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 -07001506 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1507 "IMAGE", str);
1508 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001509 if (pRegions[i].dstSubresource.layerCount == 0) {
1510 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001511 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 -07001512 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1513 "IMAGE", str);
1514 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001515 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1516 skip |= log_msg(
1517 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1518 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1519 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1520 validation_error_map[VALIDATION_ERROR_01339]);
1521 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001522 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1523 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1524 char const str[] =
1525 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1526 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1527 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1528 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1529 }
1530 }
1531
1532 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1533 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001534 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 -07001535 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1536 "IMAGE", str);
1537 }
1538 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1539 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001540 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 -07001541 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1542 str);
1543 }
1544 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1545 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1546 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1547 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1548 str, validation_error_map[VALIDATION_ERROR_01320]);
1549 }
1550 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1551 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1552 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1553 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1554 str, validation_error_map[VALIDATION_ERROR_01321]);
1555 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001556 } else {
1557 assert(0);
1558 }
1559 return skip;
1560}
1561
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001562void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1563 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001564 // Update bindings between images and cmd buffer
1565 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1566 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1567
1568 std::function<bool()> function = [=]() {
1569 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1570 };
1571 cb_node->validate_functions.push_back(function);
1572 function = [=]() {
1573 SetImageMemoryValid(device_data, dst_image_state, true);
1574 return false;
1575 };
1576 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001577 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001578}
1579
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001580bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001581 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1582 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1583
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001584 bool skip = false;
1585 if (cb_node && src_image_state && dst_image_state) {
1586 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001587 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001588 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001589 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001590 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1591 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1592 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001593 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001594 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001595 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001596 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1597 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001598
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001599 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001600
1601 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001602 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1603 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1604 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1605 std::stringstream ss;
1606 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1607 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1608 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1609 "%s", ss.str().c_str());
1610 }
1611 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1612 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1613 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1614 std::stringstream ss;
1615 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1616 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1617 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1618 "%s", ss.str().c_str());
1619 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001620 if (pRegions[i].srcSubresource.layerCount == 0) {
1621 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1622 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1623 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1624 "IMAGE", str);
1625 }
1626 if (pRegions[i].dstSubresource.layerCount == 0) {
1627 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1628 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1629 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1630 "IMAGE", str);
1631 }
1632
1633 // Check that src/dst layercounts match
1634 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1635 skip |=
1636 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1637 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1638 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1639 i, validation_error_map[VALIDATION_ERROR_01304]);
1640 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001641
1642 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1643 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1644 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1645 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1646 validation_error_map[VALIDATION_ERROR_01303]);
1647 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001648 }
1649
1650 VkFormat src_format = src_image_state->createInfo.format;
1651 VkFormat dst_format = dst_image_state->createInfo.format;
1652
1653 // Validate consistency for unsigned formats
1654 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1655 std::stringstream ss;
1656 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1657 << "the other one must also have unsigned integer format. "
1658 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1659 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1660 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1661 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1662 }
1663
1664 // Validate consistency for signed formats
1665 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1666 std::stringstream ss;
1667 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1668 << "the other one must also have signed integer format. "
1669 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1670 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1671 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1672 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1673 }
1674
1675 // Validate aspect bits and formats for depth/stencil images
1676 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001677
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001678 if (src_format != dst_format) {
1679 std::stringstream ss;
1680 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1681 << "stencil, the other one must have exactly the same format. "
1682 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1683 << string_VkFormat(dst_format);
1684 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1685 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1686 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1687 }
1688
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001689 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001690 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001691
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001692 if (vk_format_is_depth_and_stencil(src_format)) {
1693 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1694 std::stringstream ss;
1695 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1696 "VK_IMAGE_ASPECT_DEPTH_BIT "
1697 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1698 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1699 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1700 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1701 }
1702 } else if (vk_format_is_stencil_only(src_format)) {
1703 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1704 std::stringstream ss;
1705 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1706 << "set in both the srcImage and dstImage";
1707 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1708 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1709 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1710 }
1711 } else if (vk_format_is_depth_only(src_format)) {
1712 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1713 std::stringstream ss;
1714 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1715 << "set in both the srcImage and dstImage";
1716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1717 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1718 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1719 }
1720 }
1721 }
1722 }
1723
1724 // Validate filter
1725 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1726 std::stringstream ss;
1727 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1728 << "then filter must be VK_FILTER_NEAREST.";
1729 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1730 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1731 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1732 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001733 } else {
1734 assert(0);
1735 }
1736 return skip;
1737}
1738
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001739void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1740 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001741 // Update bindings between images and cmd buffer
1742 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1743 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1744
1745 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1746 cb_node->validate_functions.push_back(function);
1747 function = [=]() {
1748 SetImageMemoryValid(device_data, dst_image_state, true);
1749 return false;
1750 };
1751 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001752 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001753}
1754
Tony Barbourdf013b92017-01-25 12:53:48 -07001755// This validates that the initial layout specified in the command buffer for
1756// the IMAGE is the same
1757// as the global IMAGE layout
1758bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001759 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001760 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001761 for (auto cb_image_data : pCB->imageLayoutMap) {
1762 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001763
1764 if (!FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
1765 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1766 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1767 "Cannot submit cmd buffer using deleted image 0x%" PRIx64 ".",
1768 reinterpret_cast<const uint64_t &>(cb_image_data.first));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001769 } else {
1770 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1771 // TODO: Set memory invalid which is in mem_tracker currently
1772 } else if (imageLayout != cb_image_data.second.initialLayout) {
1773 if (cb_image_data.first.hasSubresource) {
Tony Barbourdf013b92017-01-25 12:53:48 -07001774 skip |= log_msg(
1775 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1776 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1777 "Cannot submit cmd buffer using image (0x%" PRIx64
1778 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1779 "with layout %s when first use is %s.",
1780 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
1781 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
1782 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001783 } else {
Tony Barbourdf013b92017-01-25 12:53:48 -07001784 skip |=
1785 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1786 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t &>(pCB->commandBuffer),
1787 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS", "Cannot submit cmd buffer using image (0x%" PRIx64
1788 ") with layout %s when "
1789 "first use is %s.",
1790 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), string_VkImageLayout(imageLayout),
1791 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001792 }
1793 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001794 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001795 }
1796 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001797 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001798}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001799
Tony Barbourdf013b92017-01-25 12:53:48 -07001800void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1801 for (auto cb_image_data : pCB->imageLayoutMap) {
1802 VkImageLayout imageLayout;
1803 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1804 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1805 }
1806}
1807
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001808// Print readable FlagBits in FlagMask
1809static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1810 std::string result;
1811 std::string separator;
1812
1813 if (accessMask == 0) {
1814 result = "[None]";
1815 } else {
1816 result = "[";
1817 for (auto i = 0; i < 32; i++) {
1818 if (accessMask & (1 << i)) {
1819 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1820 separator = " | ";
1821 }
1822 }
1823 result = result + "]";
1824 }
1825 return result;
1826}
1827
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001828// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1829// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001830// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001831static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
1832 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
1833 const char *type) {
1834 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1835 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001836
1837 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
1838 if (accessMask & ~(required_bit | optional_bits)) {
1839 // TODO: Verify against Valid Use
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001840 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1841 DRAWSTATE_INVALID_BARRIER, "DS",
1842 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1843 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001844 }
1845 } else {
1846 if (!required_bit) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001847 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1848 DRAWSTATE_INVALID_BARRIER, "DS",
1849 "%s AccessMask %d %s must contain at least one of access bits %d "
1850 "%s when layout is %s, unless the app has previously added a "
1851 "barrier for this transition.",
1852 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
1853 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001854 } else {
1855 std::string opt_bits;
1856 if (optional_bits != 0) {
1857 std::stringstream ss;
1858 ss << optional_bits;
1859 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
1860 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001861 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1862 DRAWSTATE_INVALID_BARRIER, "DS",
1863 "%s AccessMask %d %s must have required access bit %d %s %s when "
1864 "layout is %s, unless the app has previously added a barrier for "
1865 "this transition.",
1866 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
1867 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001868 }
1869 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001870 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001871}
1872
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001873bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
1874 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
1875 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001876
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001877 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001878 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001879 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
1880 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
1881 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
1882 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001883 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001884 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
1885 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
1886 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
1887 break;
1888 }
1889 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
1890 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
1891 break;
1892 }
1893 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
1894 skip |= ValidateMaskBits(
1895 device_data, cmdBuffer, accessMask, layout, 0,
1896 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
1897 type);
1898 break;
1899 }
1900 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
1901 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
1902 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
1903 break;
1904 }
1905 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
1906 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
1907 break;
1908 }
1909 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
1910 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
1911 break;
1912 }
1913 case VK_IMAGE_LAYOUT_UNDEFINED: {
1914 if (accessMask != 0) {
1915 // TODO: Verify against Valid Use section spec
1916 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1917 DRAWSTATE_INVALID_BARRIER, "DS",
1918 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1919 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
1920 }
1921 break;
1922 }
1923 case VK_IMAGE_LAYOUT_GENERAL:
1924 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001925 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001926 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001927}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001928
1929// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001930// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
1931// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001932bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001933 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
1934 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001935 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
1936 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1937 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
1938 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001939 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
1940 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
1941 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
1942 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001943 }
1944 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001945 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001946}
1947
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001948bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
1949 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001950 bool skip = false;
1951
1952 // Track when we're observing the first use of an attachment
1953 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
1954 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
1955 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
1956 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
1957 auto attach_index = subpass.pColorAttachments[j].attachment;
1958 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
1959
1960 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001961 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
1962 // This is ideal.
1963 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001964
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001965 case VK_IMAGE_LAYOUT_GENERAL:
1966 // May not be optimal; TODO: reconsider this warning based on other constraints?
1967 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
1968 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1969 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
1970 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001971
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001972 default:
1973 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1974 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1975 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
1976 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001977 }
1978
1979 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001980 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
1981 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001982 }
1983 attach_first_use[attach_index] = false;
1984 }
1985 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
1986 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001987 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
1988 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
1989 // These are ideal.
1990 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001991
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001992 case VK_IMAGE_LAYOUT_GENERAL:
1993 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
1994 // doing a bunch of transitions.
1995 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
1996 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1997 "GENERAL layout for depth attachment may not give optimal performance.");
1998 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001999
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002000 default:
2001 // No other layouts are acceptable
2002 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2003 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2004 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2005 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2006 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002007 }
2008
2009 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2010 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002011 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2012 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002013 }
2014 attach_first_use[attach_index] = false;
2015 }
2016 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2017 auto attach_index = subpass.pInputAttachments[j].attachment;
2018 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2019
2020 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002021 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2022 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2023 // These are ideal.
2024 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002025
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002026 case VK_IMAGE_LAYOUT_GENERAL:
2027 // May not be optimal. TODO: reconsider this warning based on other constraints.
2028 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2029 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2030 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2031 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002032
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002033 default:
2034 // No other layouts are acceptable
2035 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2036 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2037 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2038 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002039 }
2040
2041 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002042 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2043 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002044 }
2045 attach_first_use[attach_index] = false;
2046 }
2047 }
2048 return skip;
2049}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002050
2051// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002052bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2053 VkDeviceSize offset, VkDeviceSize end_offset) {
2054 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2055 bool skip = false;
2056 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2057 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002058 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2059 for (auto image_handle : mem_info->bound_images) {
2060 auto img_it = mem_info->bound_ranges.find(image_handle);
2061 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002062 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002063 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002064 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002065 for (auto layout : layouts) {
2066 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Michael Lentinec174b932017-02-10 14:57:15 -06002067 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002068 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Michael Lentinec174b932017-02-10 14:57:15 -06002069 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2070 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002071 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002072 }
2073 }
2074 }
2075 }
2076 }
2077 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002078 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002079}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002080
2081// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2082// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002083static 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 -07002084 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2085 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002086 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002087
2088 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002089 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002090 if (strict) {
2091 correct_usage = ((actual & desired) == desired);
2092 } else {
2093 correct_usage = ((actual & desired) != 0);
2094 }
2095 if (!correct_usage) {
2096 if (msgCode == -1) {
2097 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002098 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG,
2099 "MEM", "Invalid usage flag for %s 0x%" PRIxLEAST64
2100 " used by %s. In this case, %s should have %s set during creation.",
2101 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002102 } else {
2103 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002104 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2105 "Invalid usage flag for %s 0x%" PRIxLEAST64
2106 " used by %s. In this case, %s should have %s set during creation. %s",
2107 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002108 }
2109 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002110 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002111}
2112
2113// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2114// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002115bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002116 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002117 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002118 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2119 msgCode, "image", func_name, usage_string);
2120}
2121
2122// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2123// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002124bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002125 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002126 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002127 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2128 msgCode, "buffer", func_name, usage_string);
2129}
2130
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002131bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002132 bool skip = false;
2133 // TODO: Add check for VALIDATION_ERROR_00658
2134 // TODO: Add check for VALIDATION_ERROR_00666
2135 // TODO: Add check for VALIDATION_ERROR_00667
2136 // TODO: Add check for VALIDATION_ERROR_00668
2137 // TODO: Add check for VALIDATION_ERROR_00669
2138 return skip;
2139}
2140
2141void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2142 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2143 GetBufferMap(device_data)
2144 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2145}
2146
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002147bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2148 bool skip = false;
2149 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002150 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2151 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002152 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002153 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2154 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002155 skip |= ValidateBufferUsageFlags(
2156 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 -07002157 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2158 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002159 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002160}
2161
2162void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2163 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2164}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002165
2166// For the given format verify that the aspect masks make sense
2167bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2168 const char *func_name) {
2169 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2170 bool skip = false;
2171 if (vk_format_is_color(format)) {
2172 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2173 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2174 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2175 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2176 validation_error_map[VALIDATION_ERROR_00741]);
2177 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2178 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2179 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2180 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2181 validation_error_map[VALIDATION_ERROR_00741]);
2182 }
2183 } else if (vk_format_is_depth_and_stencil(format)) {
2184 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2185 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2186 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2187 "%s: Depth/stencil image formats must have "
2188 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2189 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2190 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2191 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
2192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2193 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2194 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2195 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2196 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2197 }
2198 } else if (vk_format_is_depth_only(format)) {
2199 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2200 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2201 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2202 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2203 validation_error_map[VALIDATION_ERROR_00741]);
2204 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2205 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2206 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2207 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2208 validation_error_map[VALIDATION_ERROR_00741]);
2209 }
2210 } else if (vk_format_is_stencil_only(format)) {
2211 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2212 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2213 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2214 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2215 validation_error_map[VALIDATION_ERROR_00741]);
2216 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2217 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2218 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2219 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2220 validation_error_map[VALIDATION_ERROR_00741]);
2221 }
2222 }
2223 return skip;
2224}
2225
2226bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2227 const char *func_name) {
2228 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2229 bool skip = false;
2230 if (subresourceRange.levelCount == 0) {
2231 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2232 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2233 validation_error_map[VALIDATION_ERROR_00768]);
2234 }
2235 if (subresourceRange.layerCount == 0) {
2236 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2237 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2238 validation_error_map[VALIDATION_ERROR_00769]);
2239 }
2240 return skip;
2241}
2242
2243bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2244 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2245 bool skip = false;
2246 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2247 if (image_state) {
2248 skip |= ValidateImageUsageFlags(
2249 device_data, image_state,
2250 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2251 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2252 false, -1, "vkCreateImageView()",
2253 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2254 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2255 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2256 // Checks imported from image layer
2257 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2258 std::stringstream ss;
2259 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2260 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2261 skip |=
2262 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2263 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2264 }
2265 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2266 std::stringstream ss;
2267 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2268 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2269 skip |=
2270 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2271 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2272 }
2273 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2274 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2275
2276 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2277 VkFormat image_format = image_state->createInfo.format;
2278 VkFormat view_format = create_info->format;
2279 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2280
2281 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2282 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2283 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2284 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2285 std::stringstream ss;
2286 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2287 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2288 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2289 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
2290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2291 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2292 validation_error_map[VALIDATION_ERROR_02171]);
2293 }
2294 } else {
2295 // Format MUST be IDENTICAL to the format the image was created with
2296 if (image_format != view_format) {
2297 std::stringstream ss;
2298 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2299 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2300 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
2301 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2302 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2303 validation_error_map[VALIDATION_ERROR_02172]);
2304 }
2305 }
2306
2307 // Validate correct image aspect bits for desired formats and format consistency
2308 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2309 }
2310 return skip;
2311}
2312
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002313void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2314 auto image_view_map = GetImageViewMap(device_data);
2315 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2316
2317 auto image_state = GetImageState(device_data, create_info->image);
2318 auto sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
2319 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002320}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002321
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002322bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2323 BUFFER_STATE *dst_buffer_state) {
2324 bool skip = false;
2325 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2326 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2327 // Validate that SRC & DST buffers have correct usage flags set
2328 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2329 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2330 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2331 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2332 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2333 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2334 return skip;
2335}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002336
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002337void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2338 BUFFER_STATE *dst_buffer_state) {
2339 // Update bindings between buffers and cmd buffer
2340 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2341 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2342
2343 std::function<bool()> function = [=]() {
2344 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2345 };
2346 cb_node->validate_functions.push_back(function);
2347 function = [=]() {
2348 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2349 return false;
2350 };
2351 cb_node->validate_functions.push_back(function);
2352 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2353}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002354
2355static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2356 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2357 bool skip = false;
2358 auto buffer_state = GetBufferState(device_data, buffer);
2359 if (!buffer_state) {
2360 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2361 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2362 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2363 } else {
2364 if (buffer_state->in_use.load()) {
2365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2366 __LINE__, VALIDATION_ERROR_00676, "DS",
2367 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2368 validation_error_map[VALIDATION_ERROR_00676]);
2369 }
2370 }
2371 return skip;
2372}
2373
2374bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2375 VK_OBJECT *obj_struct) {
2376 *image_view_state = GetImageViewState(device_data, image_view);
2377 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2378 if (GetDisables(device_data)->destroy_image_view) return false;
2379 bool skip = false;
2380 if (*image_view_state) {
2381 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2382 }
2383 return skip;
2384}
2385
2386void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2387 VK_OBJECT obj_struct) {
2388 // Any bound cmd buffers are now invalid
2389 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2390 (*GetImageViewMap(device_data)).erase(image_view);
2391}
2392
2393bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2394 *buffer_state = GetBufferState(device_data, buffer);
2395 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2396 if (GetDisables(device_data)->destroy_buffer) return false;
2397 bool skip = false;
2398 if (*buffer_state) {
2399 skip |= validateIdleBuffer(device_data, buffer);
2400 }
2401 return skip;
2402}
2403
2404void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2405 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2406 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2407 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2408 if (mem_info) {
2409 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2410 }
2411 }
2412 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2413 GetBufferMap(device_data)->erase(buffer_state->buffer);
2414}
2415
2416bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2417 VK_OBJECT *obj_struct) {
2418 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2419 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2420 if (GetDisables(device_data)->destroy_buffer_view) return false;
2421 bool skip = false;
2422 if (*buffer_view_state) {
2423 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2424 }
2425 return skip;
2426}
2427
2428void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2429 VK_OBJECT obj_struct) {
2430 // Any bound cmd buffers are now invalid
2431 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2432 GetBufferViewMap(device_data)->erase(buffer_view);
2433}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002434
2435bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2436 bool skip = false;
2437 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
2438 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2439 // Validate that DST buffer has correct usage flags set
2440 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2441 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2442 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2443 return skip;
2444}
2445
2446void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2447 std::function<bool()> function = [=]() {
2448 SetBufferMemoryValid(device_data, buffer_state, true);
2449 return false;
2450 };
2451 cb_node->validate_functions.push_back(function);
2452 // Update bindings between buffer and cmd buffer
2453 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2454 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2455}