blob: 76389cfc658598254406f50d3a83bc8e9c61f3c5 [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
Tony Barboure0c5cc92017-02-08 13:53:39 -070066void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
67 VkImageLayout layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -070068 imageLayoutMap[imgpair].layout = layout;
69}
70
Tobin Ehlis58c884f2017-02-08 12:15:27 -070071bool FindLayoutVerifyNode(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070072 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
73 const debug_report_data *report_data = core_validation::GetReportData(device_data);
74
75 if (!(imgpair.subresource.aspectMask & aspectMask)) {
76 return false;
77 }
78 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
79 imgpair.subresource.aspectMask = aspectMask;
80 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
81 if (imgsubIt == pCB->imageLayoutMap.end()) {
82 return false;
83 }
84 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
85 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
86 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
87 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
88 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
89 string_VkImageLayout(imgsubIt->second.layout));
90 }
91 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
92 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
93 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
94 "Cannot query for VkImage 0x%" PRIx64
95 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
96 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
97 string_VkImageLayout(imgsubIt->second.initialLayout));
98 }
99 node = imgsubIt->second;
100 return true;
101}
102
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700103bool FindLayoutVerifyLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700104 const VkImageAspectFlags aspectMask) {
105 if (!(imgpair.subresource.aspectMask & aspectMask)) {
106 return false;
107 }
108 const debug_report_data *report_data = core_validation::GetReportData(device_data);
109 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
110 imgpair.subresource.aspectMask = aspectMask;
111 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
112 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
113 return false;
114 }
115 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
116 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
117 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
118 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
119 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
120 string_VkImageLayout(imgsubIt->second.layout));
121 }
122 layout = imgsubIt->second.layout;
123 return true;
124}
125
126// Find layout(s) on the command buffer level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700127bool FindCmdBufLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700128 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
129 ImageSubresourcePair imgpair = {image, true, range};
130 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
131 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
132 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
133 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
134 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
135 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
136 imgpair = {image, false, VkImageSubresource()};
137 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
138 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
139 // TODO: This is ostensibly a find function but it changes state here
140 node = imgsubIt->second;
141 }
142 return true;
143}
144
145// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700146bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700147 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
148 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
149 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
150 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
151 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
152 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
153 imgpair = {imgpair.image, false, VkImageSubresource()};
154 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
155 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
156 layout = imgsubIt->second.layout;
157 }
158 return true;
159}
160
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700161bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700162 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
163 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700164 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700165 if (!image_state) return false;
166 bool ignoreGlobal = false;
167 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
168 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
169 ignoreGlobal = true;
170 }
171 for (auto imgsubpair : sub_data->second) {
172 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
173 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
174 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
175 layouts.push_back(img_data->second.layout);
176 }
177 }
178 return true;
179}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700180bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
181 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700182 if (!(imgpair.subresource.aspectMask & aspectMask)) {
183 return false;
184 }
185 imgpair.subresource.aspectMask = aspectMask;
186 auto imgsubIt = imageLayoutMap.find(imgpair);
187 if (imgsubIt == imageLayoutMap.end()) {
188 return false;
189 }
190 layout = imgsubIt->second.layout;
191 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700192}
Tony Barbourdf013b92017-01-25 12:53:48 -0700193
194// find layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -0700195bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
196 VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700197 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
198 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
199 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
200 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
201 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
202 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
203 imgpair = {imgpair.image, false, VkImageSubresource()};
204 auto imgsubIt = imageLayoutMap.find(imgpair);
205 if (imgsubIt == imageLayoutMap.end()) return false;
206 layout = imgsubIt->second.layout;
207 }
208 return true;
209}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210
211// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700212void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700213 VkImage &image = imgpair.image;
214 (*core_validation::GetImageLayoutMap(device_data))[imgpair].layout = layout;
215 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
216 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
217 if (subresource == image_subresources.end()) {
218 image_subresources.push_back(imgpair);
219 }
220}
221
222// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700223void 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 -0700224 pCB->imageLayoutMap[imgpair] = node;
225 auto subresource =
226 std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair);
227 if (subresource == pCB->imageSubresourceMap[imgpair.image].end()) {
228 pCB->imageSubresourceMap[imgpair.image].push_back(imgpair);
229 }
230}
231
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700232void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImageView imageView, const VkImageLayout &layout) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700233 auto view_state = GetImageViewState(device_data, imageView);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700234 assert(view_state);
235 auto image = view_state->create_info.image;
236 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
237 // TODO: Do not iterate over every possibility - consolidate where possible
238 for (uint32_t j = 0; j < subRange.levelCount; j++) {
239 uint32_t level = subRange.baseMipLevel + j;
240 for (uint32_t k = 0; k < subRange.layerCount; k++) {
241 uint32_t layer = subRange.baseArrayLayer + k;
242 VkImageSubresource sub = {subRange.aspectMask, level, layer};
243 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
244 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
245 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
246 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
247 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
248 }
249 }
250 SetLayout(device_data, pCB, image, sub, layout);
251 }
252 }
253}
254
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700255bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700256 const VkRenderPassBeginInfo *pRenderPassBegin,
257 const FRAMEBUFFER_STATE *framebuffer_state) {
258 bool skip_call = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700259 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700260 auto const &framebufferInfo = framebuffer_state->createInfo;
261 const auto report_data = core_validation::GetReportData(device_data);
262 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
263 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
264 DRAWSTATE_INVALID_RENDERPASS, "DS",
265 "You cannot start a render pass using a framebuffer "
266 "with a different number of attachments.");
267 }
268 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
269 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700270 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700271 assert(view_state);
272 const VkImage &image = view_state->create_info.image;
273 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
274 IMAGE_CMD_BUF_LAYOUT_NODE newNode = {pRenderPassInfo->pAttachments[i].initialLayout,
275 pRenderPassInfo->pAttachments[i].initialLayout};
276 // TODO: Do not iterate over every possibility - consolidate where possible
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700277 // TODO: Consolidate this with SetImageViewLayout() function above
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700278 for (uint32_t j = 0; j < subRange.levelCount; j++) {
279 uint32_t level = subRange.baseMipLevel + j;
280 for (uint32_t k = 0; k < subRange.layerCount; k++) {
281 uint32_t layer = subRange.baseArrayLayer + k;
282 VkImageSubresource sub = {subRange.aspectMask, level, layer};
283 IMAGE_CMD_BUF_LAYOUT_NODE node;
284 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700285 // If ImageView was created with depth or stencil, transition both aspects if it's a DS image
286 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
287 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
288 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
289 }
290 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700291 SetLayout(device_data, pCB, image, sub, newNode);
292 continue;
293 }
294 if (newNode.layout != VK_IMAGE_LAYOUT_UNDEFINED && newNode.layout != node.layout) {
295 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
296 DRAWSTATE_INVALID_RENDERPASS, "DS",
297 "You cannot start a render pass using attachment %u "
298 "where the render pass initial layout is %s and the previous "
299 "known layout of the attachment is %s. The layouts must match, or "
300 "the render pass initial layout for the attachment must be "
301 "VK_IMAGE_LAYOUT_UNDEFINED",
302 i, string_VkImageLayout(newNode.layout), string_VkImageLayout(node.layout));
303 }
304 }
305 }
306 }
307 return skip_call;
308}
309
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700310void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700311 VkAttachmentReference ref) {
312 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
313 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
314 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
315 }
316}
317
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700318void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
319 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700320 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700321 if (!renderPass) return;
322
323 if (framebuffer_state) {
324 auto const &subpass = renderPass->createInfo.pSubpasses[subpass_index];
325 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
326 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
327 }
328 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
329 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
330 }
331 if (subpass.pDepthStencilAttachment) {
332 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
333 }
334 }
335}
336
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700337bool TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
338 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700339 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
340 return false;
341 }
342 VkImageSubresource sub = {aspect, level, layer};
343 IMAGE_CMD_BUF_LAYOUT_NODE node;
344 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
345 SetLayout(device_data, pCB, mem_barrier->image, sub,
346 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
347 return false;
348 }
349 bool skip = false;
350 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
351 // TODO: Set memory invalid which is in mem_tracker currently
352 } else if (node.layout != mem_barrier->oldLayout) {
353 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0,
354 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
355 "You cannot transition the layout of aspect %d from %s when current layout is %s.", aspect,
356 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
357 }
358 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
359 return skip;
360}
361
362// TODO: Separate validation and layout state updates
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700363bool TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700364 const VkImageMemoryBarrier *pImgMemBarriers) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700365 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700366 bool skip = false;
367 uint32_t levelCount = 0;
368 uint32_t layerCount = 0;
369
370 for (uint32_t i = 0; i < memBarrierCount; ++i) {
371 auto mem_barrier = &pImgMemBarriers[i];
372 if (!mem_barrier) continue;
373 // TODO: Do not iterate over every possibility - consolidate where possible
374 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700375 GetImageState(device_data, mem_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700376
377 for (uint32_t j = 0; j < levelCount; j++) {
378 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
379 for (uint32_t k = 0; k < layerCount; k++) {
380 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
381 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
382 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
383 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
384 skip |= TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
385 }
386 }
387 }
388 return skip;
389}
390
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700391bool VerifySourceImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage srcImage, VkImageSubresourceLayers subLayers,
392 VkImageLayout srcImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700393 const auto report_data = core_validation::GetReportData(device_data);
394 bool skip_call = false;
395
396 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
397 uint32_t layer = i + subLayers.baseArrayLayer;
398 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
399 IMAGE_CMD_BUF_LAYOUT_NODE node;
400 if (!FindCmdBufLayout(device_data, cb_node, srcImage, sub, node)) {
401 SetLayout(device_data, cb_node, srcImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(srcImageLayout, srcImageLayout));
402 continue;
403 }
404 if (node.layout != srcImageLayout) {
405 // TODO: Improve log message in the next pass
406 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
407 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
408 "Cannot copy from an image whose source layout is %s "
409 "and doesn't match the current layout %s.",
410 string_VkImageLayout(srcImageLayout), string_VkImageLayout(node.layout));
411 }
412 }
413 if (srcImageLayout != VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) {
414 if (srcImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
415 // 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 -0700416 auto image_state = GetImageState(device_data, srcImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700417 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
418 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
419 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
420 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
421 "Layout for input image should be TRANSFER_SRC_OPTIMAL instead of GENERAL.");
422 }
423 } else {
424 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
425 "DS", "Layout for input image is %s but can only be TRANSFER_SRC_OPTIMAL or GENERAL. %s",
426 string_VkImageLayout(srcImageLayout), validation_error_map[msgCode]);
427 }
428 }
429 return skip_call;
430}
431
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700432bool VerifyDestImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage destImage, VkImageSubresourceLayers subLayers,
433 VkImageLayout destImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700434 const auto report_data = core_validation::GetReportData(device_data);
435 bool skip_call = false;
436
437 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
438 uint32_t layer = i + subLayers.baseArrayLayer;
439 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
440 IMAGE_CMD_BUF_LAYOUT_NODE node;
441 if (!FindCmdBufLayout(device_data, cb_node, destImage, sub, node)) {
442 SetLayout(device_data, cb_node, destImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(destImageLayout, destImageLayout));
443 continue;
444 }
445 if (node.layout != destImageLayout) {
446 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
447 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
448 "Cannot copy from an image whose dest layout is %s and "
449 "doesn't match the current layout %s.",
450 string_VkImageLayout(destImageLayout), string_VkImageLayout(node.layout));
451 }
452 }
453 if (destImageLayout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
454 if (destImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700455 auto image_state = GetImageState(device_data, destImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700456 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
457 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
458 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
459 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
460 "Layout for output image should be TRANSFER_DST_OPTIMAL instead of GENERAL.");
461 }
462 } else {
463 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
464 "DS", "Layout for output image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s",
465 string_VkImageLayout(destImageLayout), validation_error_map[msgCode]);
466 }
467 }
468 return skip_call;
469}
470
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700471void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
472 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700473 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700474 if (!renderPass) return;
475
476 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
477 if (framebuffer_state) {
478 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
479 auto image_view = framebuffer_state->createInfo.pAttachments[i];
480 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
481 }
482 }
483}
484
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700485bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700486 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
487 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700488 const debug_report_data *report_data = core_validation::GetReportData(device_data);
489
490 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700491 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700492
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700493 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700494 std::stringstream ss;
495 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
496 skip_call |=
497 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
498 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
499 }
500
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700501 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700502 std::stringstream ss;
503 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
504 skip_call |=
505 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
506 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
507 }
508
509 // Validate that format supports usage as color attachment
510 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
511 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700512 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700513 std::stringstream ss;
514 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL 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_02158, "IMAGE", "%s. %s", ss.str().c_str(),
518 validation_error_map[VALIDATION_ERROR_02158]);
519 }
520 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700521 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700522 std::stringstream ss;
523 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
524 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
525 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
526 __LINE__, VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(),
527 validation_error_map[VALIDATION_ERROR_02153]);
528 }
529 }
530 // Validate that format supports usage as depth/stencil attachment
531 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
532 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700533 ((properties->optimalTilingFeatures & 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_OPTIMAL 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_02159, "IMAGE", "%s. %s", ss.str().c_str(),
539 validation_error_map[VALIDATION_ERROR_02159]);
540 }
541 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700542 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700543 std::stringstream ss;
544 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
545 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
546 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
547 __LINE__, VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(),
548 validation_error_map[VALIDATION_ERROR_02154]);
549 }
550 }
551 } else {
552 skip_call |=
553 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
554 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
555 validation_error_map[VALIDATION_ERROR_00715]);
556 }
557
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700558 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
559 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700560
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700561 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700562 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
563
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700564 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
565 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
566 VALIDATION_ERROR_00716, "Image",
567 "CreateImage extent is 0 for at least one required dimension for image: "
568 "Width = %d Height = %d Depth = %d. %s",
569 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
570 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700571 }
572
573 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
574 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700575 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
576 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
577 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700578 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
579 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
580 "CreateImage extents exceed allowable limits for format: "
581 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
582 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700583 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
584 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700585 }
586
587 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
588 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
589 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
590 (uint64_t)imageGranularity) &
591 ~(uint64_t)imageGranularity;
592
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700593 if (totalSize > ImageFormatProperties->maxResourceSize) {
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 resource size exceeds allowable maximum "
597 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700598 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700599 }
600
601 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700602 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700603 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
604 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
605 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700606 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700607 }
608
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700609 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700610 skip_call |= log_msg(
611 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
612 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700613 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700614 }
615
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700616 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700617 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
618 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700619 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700620 validation_error_map[VALIDATION_ERROR_02138]);
621 }
622
623 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
624 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
625 VALIDATION_ERROR_00731, "Image",
626 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
627 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
628 validation_error_map[VALIDATION_ERROR_00731]);
629 }
630
631 return skip_call;
632}
633
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700634void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700635 IMAGE_LAYOUT_NODE image_state;
636 image_state.layout = pCreateInfo->initialLayout;
637 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700638 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 -0700639 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700640 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
641 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700642}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700643
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700644bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700645 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700646 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700647 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
648 if (disabled->destroy_image) return false;
649 bool skip = false;
650 if (*image_state) {
651 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
652 }
653 return skip;
654}
655
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700656void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700657 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
658 // Clean up memory mapping, bindings and range references for image
659 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700660 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700661 if (mem_info) {
662 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
663 }
664 }
665 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
666 // Remove image from imageMap
667 core_validation::GetImageMap(device_data)->erase(image);
668 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
669 core_validation::GetImageSubresourceMap(device_data);
670
671 const auto &sub_entry = imageSubresourceMap->find(image);
672 if (sub_entry != imageSubresourceMap->end()) {
673 for (const auto &pair : sub_entry->second) {
674 core_validation::GetImageLayoutMap(device_data)->erase(pair);
675 }
676 imageSubresourceMap->erase(sub_entry);
677 }
678}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700679
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700680bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700681 bool skip = false;
682 const debug_report_data *report_data = core_validation::GetReportData(device_data);
683
684 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
685 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
686 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
687 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
688 }
689
690 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
691 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
692 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
693 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
694 validation_error_map[VALIDATION_ERROR_01088]);
695 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
696 char const str[] = "vkCmdClearColorImage called with compressed image.";
697 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
698 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
699 validation_error_map[VALIDATION_ERROR_01088]);
700 }
701
702 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
703 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
704 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
705 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
706 validation_error_map[VALIDATION_ERROR_01084]);
707 }
708 return skip;
709}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700710
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700711void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700712 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
713 // internal state to the actual values.
714 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
715 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
716 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700717
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700718 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
719 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700720 }
721}
722
723// 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 -0700724void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
725 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700726 *levels = range.levelCount;
727 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700728 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
729 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
730 }
731 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
732 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700733 }
734}
735
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700736bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700737 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
738 bool skip = false;
739 const debug_report_data *report_data = core_validation::GetReportData(device_data);
740
741 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700742 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700743
744 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
745 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700746 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
747 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
748 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
749 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
750 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
751 }
752 } else {
753 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
754 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
755 error_code = VALIDATION_ERROR_01101;
756 } else {
757 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
758 }
759 skip |=
760 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, error_code, "DS",
761 "%s: Layout for cleared image is %s but can only be "
762 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
763 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
764 }
765 }
766
767 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
768 uint32_t level = level_index + resolved_range.baseMipLevel;
769 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
770 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
771 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
772 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700773 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700774 if (node.layout != dest_image_layout) {
775 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
776 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
777 error_code = VALIDATION_ERROR_01100;
778 } else {
779 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
780 }
781 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
782 __LINE__, error_code, "DS",
783 "%s: Cannot clear an image whose layout is %s and "
784 "doesn't match the current layout %s. %s",
785 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
786 validation_error_map[error_code]);
787 }
788 }
789 }
790 }
791
792 return skip;
793}
794
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700795void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
796 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700797 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700798 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700799
800 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
801 uint32_t level = level_index + resolved_range.baseMipLevel;
802 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
803 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
804 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
805 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700806 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
807 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 -0700808 }
809 }
810 }
811}
812
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700813bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700814 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
815 bool skip = false;
816 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700817 auto cb_node = GetCBNode(dev_data, commandBuffer);
818 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700819 if (cb_node && image_state) {
820 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
821 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
822 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
823 for (uint32_t i = 0; i < rangeCount; ++i) {
824 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700825 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700826 }
827 }
828 return skip;
829}
830
831// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700832void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
833 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700834 auto cb_node = GetCBNode(dev_data, commandBuffer);
835 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700836 if (cb_node && image_state) {
837 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
838 std::function<bool()> function = [=]() {
839 SetImageMemoryValid(dev_data, image_state, true);
840 return false;
841 };
842 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700843 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700844 for (uint32_t i = 0; i < rangeCount; ++i) {
845 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
846 }
847 }
848}
849
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700850bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
851 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700852 const VkImageSubresourceRange *pRanges) {
853 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700854 const debug_report_data *report_data = core_validation::GetReportData(device_data);
855
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700856 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700857 auto cb_node = GetCBNode(device_data, commandBuffer);
858 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700859 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700860 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
861 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
862 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700863 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700864 skip |=
865 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700866 // Image aspect must be depth or stencil or both
867 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
868 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
869 char const str[] =
870 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
871 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
873 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
874 }
875 }
876 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
877 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
878 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
879 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
880 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700881 }
882 }
883 return skip;
884}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -0700885
886// Returns true if [x, xoffset] and [y, yoffset] overlap
887static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
888 bool result = false;
889 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
890 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
891
892 if (intersection_max > intersection_min) {
893 result = true;
894 }
895 return result;
896}
897
898// Returns true if two VkImageCopy structures overlap
899static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
900 bool result = false;
901 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
902 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
903 dst->dstSubresource.layerCount))) {
904 result = true;
905 switch (type) {
906 case VK_IMAGE_TYPE_3D:
907 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
908 // Intentionally fall through to 2D case
909 case VK_IMAGE_TYPE_2D:
910 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
911 // Intentionally fall through to 1D case
912 case VK_IMAGE_TYPE_1D:
913 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
914 break;
915 default:
916 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
917 assert(false);
918 }
919 }
920 return result;
921}
922
923// Returns true if offset and extent exceed image extents
924static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const IMAGE_STATE *image_state) {
925 bool result = false;
926 // Extents/depths cannot be negative but checks left in for clarity
927 switch (image_state->createInfo.imageType) {
928 case VK_IMAGE_TYPE_3D: // Validate z and depth
929 if ((offset->z + extent->depth > image_state->createInfo.extent.depth) || (offset->z < 0) ||
930 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
931 result = true;
932 }
933 // Intentionally fall through to 2D case to check height
934 case VK_IMAGE_TYPE_2D: // Validate y and height
935 if ((offset->y + extent->height > image_state->createInfo.extent.height) || (offset->y < 0) ||
936 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
937 result = true;
938 }
939 // Intentionally fall through to 1D case to check width
940 case VK_IMAGE_TYPE_1D: // Validate x and width
941 if ((offset->x + extent->width > image_state->createInfo.extent.width) || (offset->x < 0) ||
942 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
943 result = true;
944 }
945 break;
946 default:
947 assert(false);
948 }
949 return result;
950}
951
Mark Lobodzinskiab9be282017-02-09 12:01:27 -0700952// Test if two VkExtent3D structs are equivalent
953static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
954 bool result = true;
955 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
956 (extent->depth != other_extent->depth)) {
957 result = false;
958 }
959 return result;
960}
961
962// Returns the image extent of a specific subresource.
963static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
964 const uint32_t mip = subresource->mipLevel;
965 VkExtent3D extent = img->createInfo.extent;
966 extent.width = std::max(1U, extent.width >> mip);
967 extent.height = std::max(1U, extent.height >> mip);
968 extent.depth = std::max(1U, extent.depth >> mip);
969 return extent;
970}
971
972// Test if the extent argument has all dimensions set to 0.
973static inline bool IsExtentZero(const VkExtent3D *extent) {
974 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
975}
976
977// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
978static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
979 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
980 VkExtent3D granularity = {0, 0, 0};
981 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
982 if (pPool) {
983 granularity =
984 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
985 if (vk_format_is_compressed(img->createInfo.format)) {
986 auto block_size = vk_format_compressed_block_size(img->createInfo.format);
987 granularity.width *= block_size.width;
988 granularity.height *= block_size.height;
989 }
990 }
991 return granularity;
992}
993
994// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
995static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
996 bool valid = true;
997 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
998 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
999 valid = false;
1000 }
1001 return valid;
1002}
1003
1004// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1005static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1006 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1007 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1008 bool skip = false;
1009 VkExtent3D offset_extent = {};
1010 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1011 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1012 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
1013 if (IsExtentZero(granularity)) {
1014 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
1015 if (IsExtentZero(&offset_extent) == false) {
1016 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1017 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1018 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1019 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1020 function, i, member, offset->x, offset->y, offset->z);
1021 }
1022 } else {
1023 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1024 // integer multiples of the image transfer granularity.
1025 if (IsExtentAligned(&offset_extent, granularity) == false) {
1026 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1027 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1028 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1029 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1030 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1031 granularity->depth);
1032 }
1033 }
1034 return skip;
1035}
1036
1037// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1038static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1039 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1040 const uint32_t i, const char *function, const char *member) {
1041 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1042 bool skip = false;
1043 if (IsExtentZero(granularity)) {
1044 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1045 // subresource extent.
1046 if (IsExtentEqual(extent, subresource_extent) == false) {
1047 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1048 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1049 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1050 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1051 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1052 subresource_extent->height, subresource_extent->depth);
1053 }
1054 } else {
1055 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1056 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1057 // subresource extent dimensions.
1058 VkExtent3D offset_extent_sum = {};
1059 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1060 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1061 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1062 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1063 skip |=
1064 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1065 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1066 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1067 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1068 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1069 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1070 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1071 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1072 }
1073 }
1074 return skip;
1075}
1076
1077// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1078static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1079 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1080 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1081
1082 bool skip = false;
1083 if (vk_safe_modulo(value, granularity) != 0) {
1084 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1085 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1086 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1087 "transfer granularity width (%d).",
1088 function, i, member, value, granularity);
1089 }
1090 return skip;
1091}
1092
1093// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1094static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1095 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1096 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1097 bool skip = false;
1098 if (vk_safe_modulo(value, granularity) != 0) {
1099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1100 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1101 "%s: pRegion[%d].%s (%" PRIdLEAST64
1102 ") must be an even integer multiple of this command buffer's queue family image transfer "
1103 "granularity width (%d).",
1104 function, i, member, value, granularity);
1105 }
1106 return skip;
1107}
1108
1109// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1110bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1111 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1112 const uint32_t i, const char *function) {
1113 bool skip = false;
1114 if (vk_format_is_compressed(img->createInfo.format) == true) {
1115 // TODO: Add granularity checking for compressed formats
1116
1117 // bufferRowLength must be a multiple of the compressed texel block width
1118 // bufferImageHeight must be a multiple of the compressed texel block height
1119 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1120 // bufferOffset must be a multiple of the compressed texel block size in bytes
1121 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1122 // must equal the image subresource width
1123 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1124 // must equal the image subresource height
1125 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1126 // must equal the image subresource depth
1127 } else {
1128 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1129 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1130 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1131 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1132 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1133 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1134 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1135 i, function, "imageExtent");
1136 }
1137 return skip;
1138}
1139
1140// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1141bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1142 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1143 const char *function) {
1144 bool skip = false;
1145 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1146 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1147 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1148 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1149 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1150 function, "extent");
1151 return skip;
1152}
1153
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001154bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001155 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1156 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001157 bool skip = false;
1158 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1159 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1160
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001161 for (uint32_t i = 0; i < region_count; i++) {
1162 if (regions[i].srcSubresource.layerCount == 0) {
1163 std::stringstream ss;
1164 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1165 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1166 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1167 ss.str().c_str());
1168 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001169
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001170 if (regions[i].dstSubresource.layerCount == 0) {
1171 std::stringstream ss;
1172 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1173 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1174 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1175 ss.str().c_str());
1176 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001177
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001178 // For each region the layerCount member of srcSubresource and dstSubresource must match
1179 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1180 std::stringstream ss;
1181 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1182 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1183 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1184 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1185 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001186
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001187 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1188 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1189 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1190 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1191 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1192 validation_error_map[VALIDATION_ERROR_01197]);
1193 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001194
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001195 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1196 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1197 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1198 std::stringstream ss;
1199 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1200 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1201 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1202 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1203 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001204
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001205 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1206 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1207 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1208 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1209 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1210 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1211 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1212 validation_error_map[VALIDATION_ERROR_01221]);
1213 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001214
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001215 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1216 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1217 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1218 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1219 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1220 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1221 std::stringstream ss;
1222 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1223 << "] baseArrayLayer was not zero or layerCount was not 1.";
1224 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1225 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1226 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1227 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001228
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001229 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1230 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1231 std::stringstream ss;
1232 ss << "vkCmdCopyImage: pRegions[" << i
1233 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1234 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1235 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1236 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1237 }
1238 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1239 std::stringstream ss;
1240 ss << "vkCmdCopyImage: pRegions[" << i
1241 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1243 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1244 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1245 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001246
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001247 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1248 // image was created
1249 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1250 src_image_state->createInfo.arrayLayers) {
1251 std::stringstream ss;
1252 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1253 << "] baseArrayLayer + layerCount is "
1254 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1255 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1256 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1257 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1258 }
1259 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1260 dst_image_state->createInfo.arrayLayers) {
1261 std::stringstream ss;
1262 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1263 << "] baseArrayLayer + layerCount is "
1264 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
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_01224, "IMAGE", "%s. %s",
1267 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1268 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001269
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001270 // The source region specified by a given element of regions must be a region that is contained within srcImage
1271 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, src_image_state)) {
1272 std::stringstream ss;
1273 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage 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_01175, "IMAGE", "%s. %s",
1276 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1277 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001278
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001279 // The destination region specified by a given element of regions must be a region that is contained within dst_image
1280 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, dst_image_state)) {
1281 std::stringstream ss;
1282 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1283 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1284 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1285 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1286 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001287
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001288 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1289 // must not overlap in memory
1290 if (src_image_state->image == dst_image_state->image) {
1291 for (uint32_t j = 0; j < region_count; j++) {
1292 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1293 std::stringstream ss;
1294 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1295 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1296 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1297 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001298 }
1299 }
1300 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001301 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001302
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001303 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1304 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1305 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1306 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1307 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1308 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1309 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1310 skip |=
1311 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1312 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1313 }
1314 } else {
1315 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1316 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1317 if (srcSize != destSize) {
1318 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1319 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1320 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1321 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001322 }
1323 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001324
1325 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1326 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1327 // Validate that SRC & DST images have correct usage flags set
1328 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1329 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1330 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1331 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
1332 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1333 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1334 for (uint32_t i = 0; i < region_count; ++i) {
1335 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, regions[i].srcSubresource, src_image_layout,
1336 VALIDATION_ERROR_01180);
1337 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, regions[i].dstSubresource, dst_image_layout,
1338 VALIDATION_ERROR_01183);
1339 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1340 "vkCmdCopyImage()");
1341 }
1342
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001343 return skip;
1344}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001345
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001346void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1347 IMAGE_STATE *dst_image_state) {
1348 // Update bindings between images and cmd buffer
1349 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1350 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1351 std::function<bool()> function = [=]() {
1352 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()");
1353 };
1354 cb_node->validate_functions.push_back(function);
1355 function = [=]() {
1356 SetImageMemoryValid(device_data, dst_image_state, true);
1357 return false;
1358 };
1359 cb_node->validate_functions.push_back(function);
1360 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1361}
1362
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001363// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1364// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1365// to that same cmd buffer by separate thread are not changing state from underneath us
1366// Track the last cmd buffer touched by this thread
1367static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1368 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1369 if (pCB->drawCount[i]) return true;
1370 }
1371 return false;
1372}
1373
1374// Returns true if sub_rect is entirely contained within rect
1375static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1376 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1377 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1378 return false;
1379 return true;
1380}
1381
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001382bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1383 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001384 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001385 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1386
1387 bool skip = false;
1388 if (cb_node) {
1389 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001390 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001391 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1392 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1393 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1394 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
1395 // 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
1396 // call CmdClearAttachments. Otherwise this seems more like a performance warning.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001397 skip |=
1398 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1399 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1400 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1401 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1402 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001403 }
1404 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1405 }
1406
1407 // Validate that attachment is in reference list of active subpass
1408 if (cb_node->activeRenderPass) {
1409 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1410 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001411 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001412
1413 for (uint32_t i = 0; i < attachmentCount; i++) {
1414 auto clear_desc = &pAttachments[i];
1415 VkImageView image_view = VK_NULL_HANDLE;
1416
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001417 if (0 == clear_desc->aspectMask) {
1418 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1419 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
1420 validation_error_map[VALIDATION_ERROR_01128]);
1421 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1422 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1423 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
1424 validation_error_map[VALIDATION_ERROR_01126]);
1425 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001426 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001427 skip |=
1428 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1429 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01114, "DS",
1430 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1431 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001432 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1433 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001434 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1435 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1436 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1437 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001438 } else {
1439 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001440 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001441 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001442 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1443 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1444 char const str[] =
1445 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1446 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1447 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
1448 validation_error_map[VALIDATION_ERROR_01125]);
1449 }
1450 } else { // Must be depth and/or stencil
1451 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1452 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1453 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1454 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1455 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
1456 validation_error_map[VALIDATION_ERROR_01127]);
1457 }
1458 if (!subpass_desc->pDepthStencilAttachment ||
1459 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1460 skip |= log_msg(
1461 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1462 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1463 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001464 } else {
1465 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1466 }
1467 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001468 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001469 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001470 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001471 // The rectangular region specified by a given element of pRects must be contained within the render area of
1472 // the current render pass instance
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001473 if (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect)) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001474 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1475 __LINE__, VALIDATION_ERROR_01115, "DS",
1476 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1477 "the current render pass instance. %s",
1478 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001479 }
1480 // The layers specified by a given element of pRects must be contained within every attachment that
1481 // pAttachments refers to
1482 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1483 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1484 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1485 skip |=
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001486 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1487 __LINE__, VALIDATION_ERROR_01116, "DS",
1488 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1489 "pAttachment[%d]. %s",
1490 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001491 }
1492 }
1493 }
1494 }
1495 }
1496 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001497}
1498
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001499bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001500 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001501 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001502 bool skip = false;
1503 if (cb_node && src_image_state && dst_image_state) {
1504 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1505 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
1506 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1507 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001508
1509 // For each region, the number of layers in the image subresource should not be zero
1510 // For each region, src and dest image aspect must be color only
1511 for (uint32_t i = 0; i < regionCount; i++) {
1512 if (pRegions[i].srcSubresource.layerCount == 0) {
1513 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001514 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 -07001515 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1516 "IMAGE", str);
1517 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001518 if (pRegions[i].dstSubresource.layerCount == 0) {
1519 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001520 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 -07001521 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1522 "IMAGE", str);
1523 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001524 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1525 skip |= log_msg(
1526 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_01339, "IMAGE",
1528 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1529 validation_error_map[VALIDATION_ERROR_01339]);
1530 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001531 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1532 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1533 char const str[] =
1534 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1535 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1536 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1537 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1538 }
1539 }
1540
1541 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1542 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001543 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 -07001544 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1545 "IMAGE", str);
1546 }
1547 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1548 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001549 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 -07001550 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1551 str);
1552 }
1553 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1554 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1555 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1556 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1557 str, validation_error_map[VALIDATION_ERROR_01320]);
1558 }
1559 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1560 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1561 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1562 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1563 str, validation_error_map[VALIDATION_ERROR_01321]);
1564 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001565 } else {
1566 assert(0);
1567 }
1568 return skip;
1569}
1570
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001571void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1572 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001573 // Update bindings between images and cmd buffer
1574 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1575 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1576
1577 std::function<bool()> function = [=]() {
1578 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1579 };
1580 cb_node->validate_functions.push_back(function);
1581 function = [=]() {
1582 SetImageMemoryValid(device_data, dst_image_state, true);
1583 return false;
1584 };
1585 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001586 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001587}
1588
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001589bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001590 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1591 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1592
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001593 bool skip = false;
1594 if (cb_node && src_image_state && dst_image_state) {
1595 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001596 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001597 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001598 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001599 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1600 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1601 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001602 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001603 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001604 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001605 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1606 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001607
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001608 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001609
1610 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001611 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1612 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1613 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1614 std::stringstream ss;
1615 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets 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 }
1620 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1621 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1622 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1623 std::stringstream ss;
1624 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1625 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1626 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1627 "%s", ss.str().c_str());
1628 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001629 if (pRegions[i].srcSubresource.layerCount == 0) {
1630 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1631 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1632 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1633 "IMAGE", str);
1634 }
1635 if (pRegions[i].dstSubresource.layerCount == 0) {
1636 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1637 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1638 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1639 "IMAGE", str);
1640 }
1641
1642 // Check that src/dst layercounts match
1643 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1644 skip |=
1645 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1646 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1647 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1648 i, validation_error_map[VALIDATION_ERROR_01304]);
1649 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001650
1651 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1652 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1653 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1654 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1655 validation_error_map[VALIDATION_ERROR_01303]);
1656 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001657 }
1658
1659 VkFormat src_format = src_image_state->createInfo.format;
1660 VkFormat dst_format = dst_image_state->createInfo.format;
1661
1662 // Validate consistency for unsigned formats
1663 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1664 std::stringstream ss;
1665 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1666 << "the other one must also have unsigned integer format. "
1667 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1668 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1669 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1670 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1671 }
1672
1673 // Validate consistency for signed formats
1674 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1675 std::stringstream ss;
1676 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1677 << "the other one must also have signed integer format. "
1678 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1679 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1680 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1681 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1682 }
1683
1684 // Validate aspect bits and formats for depth/stencil images
1685 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001686
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001687 if (src_format != dst_format) {
1688 std::stringstream ss;
1689 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1690 << "stencil, the other one must have exactly the same format. "
1691 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1692 << string_VkFormat(dst_format);
1693 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1694 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1695 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1696 }
1697
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001698 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001699 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001700
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001701 if (vk_format_is_depth_and_stencil(src_format)) {
1702 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1703 std::stringstream ss;
1704 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1705 "VK_IMAGE_ASPECT_DEPTH_BIT "
1706 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in 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_stencil_only(src_format)) {
1712 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1713 std::stringstream ss;
1714 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
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 } else if (vk_format_is_depth_only(src_format)) {
1721 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1722 std::stringstream ss;
1723 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1724 << "set in both the srcImage and dstImage";
1725 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1726 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1727 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1728 }
1729 }
1730 }
1731 }
1732
1733 // Validate filter
1734 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1735 std::stringstream ss;
1736 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1737 << "then filter must be VK_FILTER_NEAREST.";
1738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1739 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1740 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1741 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001742 } else {
1743 assert(0);
1744 }
1745 return skip;
1746}
1747
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001748void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1749 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001750 // Update bindings between images and cmd buffer
1751 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1752 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1753
1754 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1755 cb_node->validate_functions.push_back(function);
1756 function = [=]() {
1757 SetImageMemoryValid(device_data, dst_image_state, true);
1758 return false;
1759 };
1760 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001761 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001762}
1763
Tony Barbourdf013b92017-01-25 12:53:48 -07001764// This validates that the initial layout specified in the command buffer for
1765// the IMAGE is the same
1766// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001767bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1768 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001769 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001770 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001771 for (auto cb_image_data : pCB->imageLayoutMap) {
1772 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001773
1774 if (!FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Tony Barboure0c5cc92017-02-08 13:53:39 -07001775 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0, __LINE__,
1776 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS", "Cannot submit cmd buffer using deleted image 0x%" PRIx64 ".",
1777 reinterpret_cast<const uint64_t &>(cb_image_data.first));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001778 } else {
1779 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1780 // TODO: Set memory invalid which is in mem_tracker currently
1781 } else if (imageLayout != cb_image_data.second.initialLayout) {
1782 if (cb_image_data.first.hasSubresource) {
Tony Barboure0c5cc92017-02-08 13:53:39 -07001783 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1784 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT,
1785 "DS", "Cannot submit cmd buffer using image (0x%" PRIx64
1786 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1787 "with layout %s when first use is %s.",
1788 reinterpret_cast<const uint64_t &>(cb_image_data.first.image),
1789 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
1790 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(imageLayout),
1791 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001792 } else {
Tony Barboure0c5cc92017-02-08 13:53:39 -07001793 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1794 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT,
1795 "DS", "Cannot submit cmd buffer using image (0x%" PRIx64
1796 ") with layout %s when "
1797 "first use is %s.",
1798 reinterpret_cast<const uint64_t &>(cb_image_data.first.image),
1799 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001800 }
1801 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001802 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001803 }
1804 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001805 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001806}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001807
Tony Barbourdf013b92017-01-25 12:53:48 -07001808void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1809 for (auto cb_image_data : pCB->imageLayoutMap) {
1810 VkImageLayout imageLayout;
1811 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1812 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1813 }
1814}
1815
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001816// Print readable FlagBits in FlagMask
1817static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1818 std::string result;
1819 std::string separator;
1820
1821 if (accessMask == 0) {
1822 result = "[None]";
1823 } else {
1824 result = "[";
1825 for (auto i = 0; i < 32; i++) {
1826 if (accessMask & (1 << i)) {
1827 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1828 separator = " | ";
1829 }
1830 }
1831 result = result + "]";
1832 }
1833 return result;
1834}
1835
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001836// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1837// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001838// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001839static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
1840 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
1841 const char *type) {
1842 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1843 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001844
1845 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
1846 if (accessMask & ~(required_bit | optional_bits)) {
1847 // TODO: Verify against Valid Use
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001848 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1849 DRAWSTATE_INVALID_BARRIER, "DS",
1850 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1851 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001852 }
1853 } else {
1854 if (!required_bit) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001855 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1856 DRAWSTATE_INVALID_BARRIER, "DS",
1857 "%s AccessMask %d %s must contain at least one of access bits %d "
1858 "%s when layout is %s, unless the app has previously added a "
1859 "barrier for this transition.",
1860 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
1861 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001862 } else {
1863 std::string opt_bits;
1864 if (optional_bits != 0) {
1865 std::stringstream ss;
1866 ss << optional_bits;
1867 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
1868 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001869 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1870 DRAWSTATE_INVALID_BARRIER, "DS",
1871 "%s AccessMask %d %s must have required access bit %d %s %s when "
1872 "layout is %s, unless the app has previously added a barrier for "
1873 "this transition.",
1874 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
1875 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001876 }
1877 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001878 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001879}
1880
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001881bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
1882 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
1883 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001884
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001885 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001886 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001887 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
1888 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
1889 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
1890 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001891 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001892 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
1893 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
1894 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
1895 break;
1896 }
1897 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
1898 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
1899 break;
1900 }
1901 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
1902 skip |= ValidateMaskBits(
1903 device_data, cmdBuffer, accessMask, layout, 0,
1904 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
1905 type);
1906 break;
1907 }
1908 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
1909 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
1910 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
1911 break;
1912 }
1913 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
1914 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
1915 break;
1916 }
1917 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
1918 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
1919 break;
1920 }
1921 case VK_IMAGE_LAYOUT_UNDEFINED: {
1922 if (accessMask != 0) {
1923 // TODO: Verify against Valid Use section spec
1924 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1925 DRAWSTATE_INVALID_BARRIER, "DS",
1926 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1927 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
1928 }
1929 break;
1930 }
1931 case VK_IMAGE_LAYOUT_GENERAL:
1932 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001933 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001934 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001935}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001936
1937// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001938// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
1939// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001940bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001941 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
1942 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001943 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
1944 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1945 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
1946 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001947 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
1948 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
1949 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
1950 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001951 }
1952 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001953 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001954}
1955
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001956bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
1957 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001958 bool skip = false;
1959
1960 // Track when we're observing the first use of an attachment
1961 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
1962 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
1963 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
1964 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
1965 auto attach_index = subpass.pColorAttachments[j].attachment;
1966 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
1967
1968 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001969 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
1970 // This is ideal.
1971 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001972
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001973 case VK_IMAGE_LAYOUT_GENERAL:
1974 // May not be optimal; TODO: reconsider this warning based on other constraints?
1975 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
1976 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1977 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
1978 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001979
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001980 default:
1981 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1982 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1983 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
1984 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001985 }
1986
1987 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001988 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
1989 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001990 }
1991 attach_first_use[attach_index] = false;
1992 }
1993 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
1994 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001995 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
1996 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
1997 // These are ideal.
1998 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001999
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002000 case VK_IMAGE_LAYOUT_GENERAL:
2001 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2002 // doing a bunch of transitions.
2003 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2004 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2005 "GENERAL layout for depth attachment may not give optimal performance.");
2006 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002007
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002008 default:
2009 // No other layouts are acceptable
2010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2011 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2012 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2013 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2014 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002015 }
2016
2017 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2018 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002019 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2020 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002021 }
2022 attach_first_use[attach_index] = false;
2023 }
2024 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2025 auto attach_index = subpass.pInputAttachments[j].attachment;
2026 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2027
2028 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002029 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2030 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2031 // These are ideal.
2032 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002033
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002034 case VK_IMAGE_LAYOUT_GENERAL:
2035 // May not be optimal. TODO: reconsider this warning based on other constraints.
2036 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2037 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2038 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2039 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002040
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002041 default:
2042 // No other layouts are acceptable
2043 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2044 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2045 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2046 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002047 }
2048
2049 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002050 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2051 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002052 }
2053 attach_first_use[attach_index] = false;
2054 }
2055 }
2056 return skip;
2057}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002058
2059// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002060bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2061 VkDeviceSize offset, VkDeviceSize end_offset) {
2062 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2063 bool skip = false;
2064 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2065 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002066 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2067 for (auto image_handle : mem_info->bound_images) {
2068 auto img_it = mem_info->bound_ranges.find(image_handle);
2069 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002070 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002071 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002072 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002073 for (auto layout : layouts) {
2074 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Michael Lentinec174b932017-02-10 14:57:15 -06002075 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002076 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Michael Lentinec174b932017-02-10 14:57:15 -06002077 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2078 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002079 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002080 }
2081 }
2082 }
2083 }
2084 }
2085 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002086 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002087}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002088
2089// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2090// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002091static 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 -07002092 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2093 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002094 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002095
2096 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002097 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002098 if (strict) {
2099 correct_usage = ((actual & desired) == desired);
2100 } else {
2101 correct_usage = ((actual & desired) != 0);
2102 }
2103 if (!correct_usage) {
2104 if (msgCode == -1) {
2105 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002106 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG,
2107 "MEM", "Invalid usage flag for %s 0x%" PRIxLEAST64
2108 " used by %s. In this case, %s should have %s set during creation.",
2109 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002110 } else {
2111 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002112 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2113 "Invalid usage flag for %s 0x%" PRIxLEAST64
2114 " used by %s. In this case, %s should have %s set during creation. %s",
2115 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002116 }
2117 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002118 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002119}
2120
2121// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2122// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002123bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002124 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002125 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002126 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2127 msgCode, "image", func_name, usage_string);
2128}
2129
2130// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2131// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002132bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002133 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002134 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002135 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2136 msgCode, "buffer", func_name, usage_string);
2137}
2138
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002139bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002140 bool skip = false;
2141 // TODO: Add check for VALIDATION_ERROR_00658
2142 // TODO: Add check for VALIDATION_ERROR_00666
2143 // TODO: Add check for VALIDATION_ERROR_00667
2144 // TODO: Add check for VALIDATION_ERROR_00668
2145 // TODO: Add check for VALIDATION_ERROR_00669
2146 return skip;
2147}
2148
2149void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2150 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2151 GetBufferMap(device_data)
2152 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2153}
2154
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002155bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2156 bool skip = false;
2157 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002158 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2159 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002160 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002161 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2162 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002163 skip |= ValidateBufferUsageFlags(
2164 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 -07002165 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2166 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002167 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002168}
2169
2170void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2171 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2172}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002173
2174// For the given format verify that the aspect masks make sense
2175bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2176 const char *func_name) {
2177 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2178 bool skip = false;
2179 if (vk_format_is_color(format)) {
2180 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2181 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2182 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2183 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2184 validation_error_map[VALIDATION_ERROR_00741]);
2185 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2187 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2188 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2189 validation_error_map[VALIDATION_ERROR_00741]);
2190 }
2191 } else if (vk_format_is_depth_and_stencil(format)) {
2192 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2193 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2194 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2195 "%s: Depth/stencil image formats must have "
2196 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2197 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2198 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2199 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
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: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2203 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2204 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2205 }
2206 } else if (vk_format_is_depth_only(format)) {
2207 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2208 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2209 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2210 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2211 validation_error_map[VALIDATION_ERROR_00741]);
2212 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2213 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2214 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2215 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2216 validation_error_map[VALIDATION_ERROR_00741]);
2217 }
2218 } else if (vk_format_is_stencil_only(format)) {
2219 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2220 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2221 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2222 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2223 validation_error_map[VALIDATION_ERROR_00741]);
2224 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2226 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2227 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2228 validation_error_map[VALIDATION_ERROR_00741]);
2229 }
2230 }
2231 return skip;
2232}
2233
2234bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2235 const char *func_name) {
2236 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2237 bool skip = false;
2238 if (subresourceRange.levelCount == 0) {
2239 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2240 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2241 validation_error_map[VALIDATION_ERROR_00768]);
2242 }
2243 if (subresourceRange.layerCount == 0) {
2244 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2245 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2246 validation_error_map[VALIDATION_ERROR_00769]);
2247 }
2248 return skip;
2249}
2250
2251bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2252 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2253 bool skip = false;
2254 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2255 if (image_state) {
2256 skip |= ValidateImageUsageFlags(
2257 device_data, image_state,
2258 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2259 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2260 false, -1, "vkCreateImageView()",
2261 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2262 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2263 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2264 // Checks imported from image layer
2265 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2266 std::stringstream ss;
2267 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2268 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2269 skip |=
2270 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2271 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2272 }
2273 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2274 std::stringstream ss;
2275 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2276 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2277 skip |=
2278 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2279 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2280 }
2281 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2282 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2283
2284 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2285 VkFormat image_format = image_state->createInfo.format;
2286 VkFormat view_format = create_info->format;
2287 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2288
2289 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2290 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2291 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2292 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2293 std::stringstream ss;
2294 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2295 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2296 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2297 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
2298 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2299 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2300 validation_error_map[VALIDATION_ERROR_02171]);
2301 }
2302 } else {
2303 // Format MUST be IDENTICAL to the format the image was created with
2304 if (image_format != view_format) {
2305 std::stringstream ss;
2306 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2307 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2308 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
2309 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2310 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2311 validation_error_map[VALIDATION_ERROR_02172]);
2312 }
2313 }
2314
2315 // Validate correct image aspect bits for desired formats and format consistency
2316 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2317 }
2318 return skip;
2319}
2320
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002321void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2322 auto image_view_map = GetImageViewMap(device_data);
2323 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2324
2325 auto image_state = GetImageState(device_data, create_info->image);
2326 auto sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
2327 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002328}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002329
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002330bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2331 BUFFER_STATE *dst_buffer_state) {
2332 bool skip = false;
2333 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2334 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2335 // Validate that SRC & DST buffers have correct usage flags set
2336 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2337 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2338 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2339 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2340 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2341 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2342 return skip;
2343}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002344
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002345void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2346 BUFFER_STATE *dst_buffer_state) {
2347 // Update bindings between buffers and cmd buffer
2348 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2349 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2350
2351 std::function<bool()> function = [=]() {
2352 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2353 };
2354 cb_node->validate_functions.push_back(function);
2355 function = [=]() {
2356 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2357 return false;
2358 };
2359 cb_node->validate_functions.push_back(function);
2360 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2361}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002362
2363static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2364 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2365 bool skip = false;
2366 auto buffer_state = GetBufferState(device_data, buffer);
2367 if (!buffer_state) {
2368 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2369 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2370 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2371 } else {
2372 if (buffer_state->in_use.load()) {
2373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2374 __LINE__, VALIDATION_ERROR_00676, "DS",
2375 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2376 validation_error_map[VALIDATION_ERROR_00676]);
2377 }
2378 }
2379 return skip;
2380}
2381
2382bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2383 VK_OBJECT *obj_struct) {
2384 *image_view_state = GetImageViewState(device_data, image_view);
2385 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2386 if (GetDisables(device_data)->destroy_image_view) return false;
2387 bool skip = false;
2388 if (*image_view_state) {
2389 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2390 }
2391 return skip;
2392}
2393
2394void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2395 VK_OBJECT obj_struct) {
2396 // Any bound cmd buffers are now invalid
2397 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2398 (*GetImageViewMap(device_data)).erase(image_view);
2399}
2400
2401bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2402 *buffer_state = GetBufferState(device_data, buffer);
2403 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2404 if (GetDisables(device_data)->destroy_buffer) return false;
2405 bool skip = false;
2406 if (*buffer_state) {
2407 skip |= validateIdleBuffer(device_data, buffer);
2408 }
2409 return skip;
2410}
2411
2412void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2413 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2414 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2415 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2416 if (mem_info) {
2417 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2418 }
2419 }
2420 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2421 GetBufferMap(device_data)->erase(buffer_state->buffer);
2422}
2423
2424bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2425 VK_OBJECT *obj_struct) {
2426 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2427 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2428 if (GetDisables(device_data)->destroy_buffer_view) return false;
2429 bool skip = false;
2430 if (*buffer_view_state) {
2431 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2432 }
2433 return skip;
2434}
2435
2436void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2437 VK_OBJECT obj_struct) {
2438 // Any bound cmd buffers are now invalid
2439 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2440 GetBufferViewMap(device_data)->erase(buffer_view);
2441}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002442
2443bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2444 bool skip = false;
2445 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
2446 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2447 // Validate that DST buffer has correct usage flags set
2448 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2449 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2450 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2451 return skip;
2452}
2453
2454void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2455 std::function<bool()> function = [=]() {
2456 SetBufferMemoryValid(device_data, buffer_state, true);
2457 return false;
2458 };
2459 cb_node->validate_functions.push_back(function);
2460 // Update bindings between buffer and cmd buffer
2461 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2462 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2463}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002464
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002465bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2466 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002467 bool skip = false;
2468
2469 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002470 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002471 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
2472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002473 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002474 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2475 "must be 0 and 1, respectively. %s",
2476 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2477 validation_error_map[VALIDATION_ERROR_01746]);
2478 }
2479 }
2480
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002481 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002482 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
2483 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002484 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002485 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2486 "must be 0 and 1, respectively. %s",
2487 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2488 validation_error_map[VALIDATION_ERROR_01747]);
2489 }
2490 }
2491
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002492 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002493 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2494 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002495 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002496 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2497 "%d. For 3D images these must be 0 and 1, respectively. %s",
2498 function, i, pRegions[i].imageSubresource.baseArrayLayer,
2499 pRegions[i].imageSubresource.layerCount, validation_error_map[VALIDATION_ERROR_01281]);
2500 }
2501 }
2502
2503 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2504 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002505 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2506 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002507 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2508 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002509 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002510 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2511 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2512 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2513 }
2514
2515 // BufferOffset must be a multiple of 4
2516 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2517 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002518 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002519 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2520 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2521 }
2522
2523 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2524 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2525 skip |= log_msg(
2526 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002527 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002528 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2529 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2530 validation_error_map[VALIDATION_ERROR_01265]);
2531 }
2532
2533 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2534 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2535 skip |= log_msg(
2536 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002537 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002538 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2539 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2540 validation_error_map[VALIDATION_ERROR_01266]);
2541 }
2542
2543 // subresource aspectMask must have exactly 1 bit set
2544 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2545 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2546 if (aspect_mask_bits.count() != 1) {
2547 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002548 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002549 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2550 validation_error_map[VALIDATION_ERROR_01280]);
2551 }
2552
2553 // image subresource aspect bit must match format
2554 if (((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT)) &&
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002555 (!vk_format_is_color(image_state->createInfo.format))) ||
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002556 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT)) &&
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002557 (!vk_format_has_depth(image_state->createInfo.format))) ||
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002558 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) &&
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002559 (!vk_format_has_stencil(image_state->createInfo.format)))) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002560 skip |= log_msg(
2561 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002562 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002563 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002564 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002565 validation_error_map[VALIDATION_ERROR_01279]);
2566 }
2567
2568 // Checks that apply only to compressed images
2569 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2570 // reserves a place for these compressed image checks. This block of code could move there once the image
2571 // stuff is moved into core validation.
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002572 if (vk_format_is_compressed(image_state->createInfo.format)) {
2573 VkExtent2D block_size = vk_format_compressed_block_size(image_state->createInfo.format);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002574
2575 // BufferRowLength must be a multiple of block width
2576 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
2577 skip |= log_msg(
2578 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002579 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002580 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2581 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
2582 }
2583
2584 // BufferRowHeight must be a multiple of block height
2585 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
2586 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002587 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002588 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2589 "height (%d). %s.",
2590 function, i, pRegions[i].bufferImageHeight, block_size.height,
2591 validation_error_map[VALIDATION_ERROR_01272]);
2592 }
2593
2594 // image offsets must be multiples of block dimensions
2595 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
2596 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0)) {
2597 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002598 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002599 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2600 "width & height (%d, %d). %s.",
2601 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2602 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
2603 }
2604
2605 // bufferOffset must be a multiple of block size (linear bytes)
2606 int block_size_in_bytes = block_size.width * block_size.height;
2607 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
2608 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002609 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01274, "IMAGE",
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002610 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64 ") must be a multiple of the compressed image's texel block "
2611 "size (0x%x). %s.",
2612 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2613 validation_error_map[VALIDATION_ERROR_01274]);
2614 }
2615 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002616 }
2617
2618 return skip;
2619}
2620
2621static bool ValidateImageBounds(const debug_report_data *report_data, const VkImageCreateInfo *image_info,
2622 const uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2623 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2624 bool skip = false;
2625
2626 for (uint32_t i = 0; i < regionCount; i++) {
2627 bool overrun = false;
2628 VkExtent3D extent = pRegions[i].imageExtent;
2629 VkOffset3D offset = pRegions[i].imageOffset;
2630 VkExtent3D image_extent = image_info->extent;
2631
2632 // for compressed images, the image createInfo.extent is in texel blocks
2633 // convert to texels here
2634 if (vk_format_is_compressed(image_info->format)) {
2635 VkExtent2D texel_block_extent = vk_format_compressed_block_size(image_info->format);
2636 image_extent.width *= texel_block_extent.width;
2637 image_extent.height *= texel_block_extent.height;
2638 }
2639
2640 // Extents/depths cannot be negative but checks left in for clarity
2641 switch (image_info->imageType) {
2642 case VK_IMAGE_TYPE_3D: // Validate z and depth
2643 if ((offset.z + extent.depth > image_extent.depth) || (offset.z < 0) ||
2644 ((offset.z + static_cast<int32_t>(extent.depth)) < 0)) {
2645 overrun = true;
2646 }
2647 // Intentionally fall through to 2D case to check height
2648 case VK_IMAGE_TYPE_2D: // Validate y and height
2649 if ((offset.y + extent.height > image_extent.height) || (offset.y < 0) ||
2650 ((offset.y + static_cast<int32_t>(extent.height)) < 0)) {
2651 overrun = true;
2652 }
2653 // Intentionally fall through to 1D case to check width
2654 case VK_IMAGE_TYPE_1D: // Validate x and width
2655 if ((offset.x + extent.width > image_extent.width) || (offset.x < 0) ||
2656 ((offset.x + static_cast<int32_t>(extent.width)) < 0)) {
2657 overrun = true;
2658 }
2659 break;
2660 default:
2661 assert(false);
2662 }
2663
2664 if (overrun) {
2665 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2666 __LINE__, msg_code, "DS", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
2667 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002668 }
2669 }
2670
2671 return skip;
2672}
2673
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002674static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2675 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2676 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2677 bool skip = false;
2678
2679 VkDeviceSize buffer_size = buff_state->createInfo.size;
2680
2681 for (uint32_t i = 0; i < regionCount; i++) {
2682 VkExtent3D copy_extent = pRegions[i].imageExtent;
2683
2684 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2685 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2686 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2687
2688 if (vk_format_is_compressed(image_state->createInfo.format)) {
2689 VkExtent2D texel_block_extent = vk_format_compressed_block_size(image_state->createInfo.format);
2690 buffer_width /= texel_block_extent.width; // switch to texel block units
2691 buffer_height /= texel_block_extent.height;
2692 copy_extent.width /= texel_block_extent.width;
2693 copy_extent.height /= texel_block_extent.height;
2694 }
2695
2696 // Either depth or layerCount must be 1 (or both). This is the number of 'slices' to copy
2697 uint32_t zCopy = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2698 assert(zCopy > 0);
2699
2700 // Calculate buffer offset of final copied byte, + 1.
2701 VkDeviceSize max_buffer_offset = (zCopy - 1) * buffer_height * buffer_width; // offset to slice
2702 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2703 max_buffer_offset *= unit_size; // convert to bytes
2704 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
2705
2706 if (buffer_size < max_buffer_offset) {
2707 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2708 __LINE__, msg_code, "DS", "%s: pRegion[%d] exceeds buffer bounds. %s.", func_name, i,
2709 validation_error_map[msg_code]);
2710 }
2711 }
2712
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002713 return skip;
2714}
2715
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002716bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002717 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002718 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002719 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2720 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2721
2722 // Validate command buffer state
2723 if (CB_RECORDING != cb_node->state) {
2724 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2725 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2726 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2727 validation_error_map[VALIDATION_ERROR_01258]);
2728 } else {
2729 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2730 }
2731
2732 // Command pool must support graphics, compute, or transfer operations
2733 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2734
2735 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2736 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2737 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2738 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2739 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2740 "or transfer capabilities. %s.",
2741 validation_error_map[VALIDATION_ERROR_01259]);
2742 }
2743 skip |= ValidateImageBounds(report_data, &(src_image_state->createInfo), regionCount, pRegions, "vkCmdCopyBufferToImage()",
2744 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002745 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002746 VALIDATION_ERROR_01246);
2747
2748 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2749 VALIDATION_ERROR_01249);
2750 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002751 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002752
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002753 // Validate that SRC image & DST buffer have correct usage flags set
2754 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2755 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002756 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002757 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002758 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
2759 for (uint32_t i = 0; i < regionCount; ++i) {
2760 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, pRegions[i].imageSubresource, srcImageLayout,
2761 VALIDATION_ERROR_01251);
2762 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
2763 "CmdCopyImageToBuffer");
2764 }
2765 return skip;
2766}
2767
2768void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002769 BUFFER_STATE *dst_buffer_state) {
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002770 // Update bindings between buffer/image and cmd buffer
2771 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002772 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002773
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002774 std::function<bool()> function = [=]() {
2775 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
2776 };
2777 cb_node->validate_functions.push_back(function);
2778 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002779 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002780 return false;
2781 };
2782 cb_node->validate_functions.push_back(function);
2783
2784 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002785}
2786
2787bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002788 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002789 const VkBufferImageCopy *pRegions, const char *func_name) {
2790 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2791 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
2792
2793 // Validate command buffer state
2794 if (CB_RECORDING != cb_node->state) {
2795 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2796 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
2797 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
2798 validation_error_map[VALIDATION_ERROR_01240]);
2799 } else {
2800 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
2801 }
2802
2803 // Command pool must support graphics, compute, or transfer operations
2804 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2805 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2806 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2808 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
2809 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
2810 "or transfer capabilities. %s.",
2811 validation_error_map[VALIDATION_ERROR_01241]);
2812 }
2813 skip |= ValidateImageBounds(report_data, &(dst_image_state->createInfo), regionCount, pRegions, "vkCmdCopyBufferToImage()",
2814 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002815 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002816 VALIDATION_ERROR_01227);
2817 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
2818 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002819 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002820 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002821 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002822 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2823 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
2824 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002825 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
2826 for (uint32_t i = 0; i < regionCount; ++i) {
2827 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, pRegions[i].imageSubresource, dstImageLayout,
2828 VALIDATION_ERROR_01234);
2829 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
2830 "vkCmdCopyBufferToImage()");
2831 }
2832 return skip;
2833}
2834
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002835void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002836 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002837 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002838 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002839 std::function<bool()> function = [=]() {
2840 SetImageMemoryValid(device_data, dst_image_state, true);
2841 return false;
2842 };
2843 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002844 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002845 cb_node->validate_functions.push_back(function);
2846
2847 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002848}
Mike Weiblen672b58b2017-02-21 14:32:53 -07002849
2850bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
2851 const auto report_data = core_validation::GetReportData(device_data);
2852 bool skip = false;
2853 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
2854
2855 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
2856 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
2857 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
2858 if (aspect_mask_bits.count() != 1) {
2859 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2860 VALIDATION_ERROR_00733, "IMAGE",
2861 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
2862 validation_error_map[VALIDATION_ERROR_00733]);
2863 }
2864
2865 IMAGE_STATE *image_entry = GetImageState(device_data, image);
2866 if (!image_entry) {
2867 return skip;
2868 }
2869
2870 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
2871 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
2872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2873 __LINE__, VALIDATION_ERROR_00732, "IMAGE",
2874 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
2875 validation_error_map[VALIDATION_ERROR_00732]);
2876 }
2877
2878 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
2879 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
2880 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2881 __LINE__, VALIDATION_ERROR_00739, "IMAGE",
2882 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
2883 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
2884 }
2885
2886 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
2887 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
2888 skip |= log_msg(
2889 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
2890 VALIDATION_ERROR_00740, "IMAGE", "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
2891 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
2892 }
2893
2894 // VU 00741: subresource's aspect must be compatible with image's format.
2895 const VkFormat img_format = image_entry->createInfo.format;
2896 if (vk_format_is_color(img_format)) {
2897 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
2898 skip |= log_msg(
2899 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
2900 VALIDATION_ERROR_00741, "IMAGE",
2901 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
2902 validation_error_map[VALIDATION_ERROR_00741]);
2903 }
2904 } else if (vk_format_is_depth_or_stencil(img_format)) {
2905 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2906 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2907 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2908 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
2909 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
2910 validation_error_map[VALIDATION_ERROR_00741]);
2911 }
2912 }
2913 return skip;
2914}