blob: f237d645237ac8d36d0efd2cbe932291c0deb4d2 [file] [log] [blame]
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07001/* Copyright (c) 2015-2017 The Khronos Group Inc.
2 * Copyright (c) 2015-2017 Valve Corporation
3 * Copyright (c) 2015-2017 LunarG, Inc.
4 * Copyright (C) 2015-2017 Google Inc.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
19 */
20
21// Allow use of STL min and max functions in Windows
22#define NOMINMAX
23
Mark Lobodzinski90224de2017-01-26 15:23:11 -070024#include <sstream>
25
26#include "vk_enum_string_helper.h"
27#include "vk_layer_data.h"
28#include "vk_layer_utils.h"
29#include "vk_layer_logging.h"
30
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070031#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070032
Tobin Ehlis58c884f2017-02-08 12:15:27 -070033void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070034 if (std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair) !=
35 pCB->imageSubresourceMap[imgpair.image].end()) {
36 pCB->imageLayoutMap[imgpair].layout = layout;
37 } else {
38 assert(imgpair.hasSubresource);
39 IMAGE_CMD_BUF_LAYOUT_NODE node;
40 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
41 node.initialLayout = layout;
42 }
43 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
44 }
45}
46template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070047void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070048 ImageSubresourcePair imgpair = {image, true, range};
49 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
50 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
51 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
53}
54
55template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070056void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070057 VkImageAspectFlags aspectMask) {
58 if (imgpair.subresource.aspectMask & aspectMask) {
59 imgpair.subresource.aspectMask = aspectMask;
60 SetLayout(device_data, pObject, imgpair, layout);
61 }
62}
63
Tony Barbourdf013b92017-01-25 12:53:48 -070064// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070065void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
66 VkImageLayout layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -070067 imageLayoutMap[imgpair].layout = layout;
68}
69
Tobin Ehlis58c884f2017-02-08 12:15:27 -070070bool FindLayoutVerifyNode(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070071 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
72 const debug_report_data *report_data = core_validation::GetReportData(device_data);
73
74 if (!(imgpair.subresource.aspectMask & aspectMask)) {
75 return false;
76 }
77 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
78 imgpair.subresource.aspectMask = aspectMask;
79 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
80 if (imgsubIt == pCB->imageLayoutMap.end()) {
81 return false;
82 }
83 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
84 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
85 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
86 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
87 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
88 string_VkImageLayout(imgsubIt->second.layout));
89 }
90 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
91 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
92 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
93 "Cannot query for VkImage 0x%" PRIx64
94 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
95 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
96 string_VkImageLayout(imgsubIt->second.initialLayout));
97 }
98 node = imgsubIt->second;
99 return true;
100}
101
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700102bool FindLayoutVerifyLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700103 const VkImageAspectFlags aspectMask) {
104 if (!(imgpair.subresource.aspectMask & aspectMask)) {
105 return false;
106 }
107 const debug_report_data *report_data = core_validation::GetReportData(device_data);
108 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
109 imgpair.subresource.aspectMask = aspectMask;
110 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
111 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
112 return false;
113 }
114 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
115 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
116 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
117 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
118 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
119 string_VkImageLayout(imgsubIt->second.layout));
120 }
121 layout = imgsubIt->second.layout;
122 return true;
123}
124
125// Find layout(s) on the command buffer level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700126bool FindCmdBufLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700127 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
128 ImageSubresourcePair imgpair = {image, true, range};
129 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
130 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
131 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
132 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
133 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
134 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
135 imgpair = {image, false, VkImageSubresource()};
136 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
137 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
138 // TODO: This is ostensibly a find function but it changes state here
139 node = imgsubIt->second;
140 }
141 return true;
142}
143
144// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700145bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700146 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
147 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
148 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
149 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
150 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
151 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
152 imgpair = {imgpair.image, false, VkImageSubresource()};
153 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
154 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
155 layout = imgsubIt->second.layout;
156 }
157 return true;
158}
159
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700160bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700161 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
162 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700163 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700164 if (!image_state) return false;
165 bool ignoreGlobal = false;
166 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
167 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
168 ignoreGlobal = true;
169 }
170 for (auto imgsubpair : sub_data->second) {
171 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
172 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
173 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
174 layouts.push_back(img_data->second.layout);
175 }
176 }
177 return true;
178}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700179bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
180 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700181 if (!(imgpair.subresource.aspectMask & aspectMask)) {
182 return false;
183 }
184 imgpair.subresource.aspectMask = aspectMask;
185 auto imgsubIt = imageLayoutMap.find(imgpair);
186 if (imgsubIt == imageLayoutMap.end()) {
187 return false;
188 }
189 layout = imgsubIt->second.layout;
190 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700191}
Tony Barbourdf013b92017-01-25 12:53:48 -0700192
193// find layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -0700194bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
195 VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700196 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
197 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
198 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
199 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
200 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
201 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
202 imgpair = {imgpair.image, false, VkImageSubresource()};
203 auto imgsubIt = imageLayoutMap.find(imgpair);
204 if (imgsubIt == imageLayoutMap.end()) return false;
205 layout = imgsubIt->second.layout;
206 }
207 return true;
208}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700209
210// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700211void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700212 VkImage &image = imgpair.image;
213 (*core_validation::GetImageLayoutMap(device_data))[imgpair].layout = layout;
214 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
215 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
216 if (subresource == image_subresources.end()) {
217 image_subresources.push_back(imgpair);
218 }
219}
220
221// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700222void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700223 pCB->imageLayoutMap[imgpair] = node;
224 auto subresource =
225 std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair);
226 if (subresource == pCB->imageSubresourceMap[imgpair.image].end()) {
227 pCB->imageSubresourceMap[imgpair.image].push_back(imgpair);
228 }
229}
230
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700231void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImageView imageView, const VkImageLayout &layout) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700232 auto view_state = GetImageViewState(device_data, imageView);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700233 assert(view_state);
234 auto image = view_state->create_info.image;
235 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
236 // TODO: Do not iterate over every possibility - consolidate where possible
237 for (uint32_t j = 0; j < subRange.levelCount; j++) {
238 uint32_t level = subRange.baseMipLevel + j;
239 for (uint32_t k = 0; k < subRange.layerCount; k++) {
240 uint32_t layer = subRange.baseArrayLayer + k;
241 VkImageSubresource sub = {subRange.aspectMask, level, layer};
242 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
243 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
244 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
245 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
246 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
247 }
248 }
249 SetLayout(device_data, pCB, image, sub, layout);
250 }
251 }
252}
253
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700254bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700255 const VkRenderPassBeginInfo *pRenderPassBegin,
256 const FRAMEBUFFER_STATE *framebuffer_state) {
257 bool skip_call = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700258 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700259 auto const &framebufferInfo = framebuffer_state->createInfo;
260 const auto report_data = core_validation::GetReportData(device_data);
261 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
262 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
263 DRAWSTATE_INVALID_RENDERPASS, "DS",
264 "You cannot start a render pass using a framebuffer "
265 "with a different number of attachments.");
266 }
267 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
268 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700269 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700270 assert(view_state);
271 const VkImage &image = view_state->create_info.image;
272 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
273 IMAGE_CMD_BUF_LAYOUT_NODE newNode = {pRenderPassInfo->pAttachments[i].initialLayout,
274 pRenderPassInfo->pAttachments[i].initialLayout};
275 // TODO: Do not iterate over every possibility - consolidate where possible
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700276 // TODO: Consolidate this with SetImageViewLayout() function above
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700277 for (uint32_t j = 0; j < subRange.levelCount; j++) {
278 uint32_t level = subRange.baseMipLevel + j;
279 for (uint32_t k = 0; k < subRange.layerCount; k++) {
280 uint32_t layer = subRange.baseArrayLayer + k;
281 VkImageSubresource sub = {subRange.aspectMask, level, layer};
282 IMAGE_CMD_BUF_LAYOUT_NODE node;
283 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700284 // If ImageView was created with depth or stencil, transition both aspects if it's a DS image
285 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
286 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
287 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
288 }
289 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700290 SetLayout(device_data, pCB, image, sub, newNode);
291 continue;
292 }
293 if (newNode.layout != VK_IMAGE_LAYOUT_UNDEFINED && newNode.layout != node.layout) {
294 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
295 DRAWSTATE_INVALID_RENDERPASS, "DS",
296 "You cannot start a render pass using attachment %u "
297 "where the render pass initial layout is %s and the previous "
298 "known layout of the attachment is %s. The layouts must match, or "
299 "the render pass initial layout for the attachment must be "
300 "VK_IMAGE_LAYOUT_UNDEFINED",
301 i, string_VkImageLayout(newNode.layout), string_VkImageLayout(node.layout));
302 }
303 }
304 }
305 }
306 return skip_call;
307}
308
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700309void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700310 VkAttachmentReference ref) {
311 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
312 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
313 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
314 }
315}
316
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700317void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
318 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700319 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700320 if (!renderPass) return;
321
322 if (framebuffer_state) {
323 auto const &subpass = renderPass->createInfo.pSubpasses[subpass_index];
324 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
325 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
326 }
327 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
328 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
329 }
330 if (subpass.pDepthStencilAttachment) {
331 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
332 }
333 }
334}
335
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700336bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
337 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700338 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
339 return false;
340 }
341 VkImageSubresource sub = {aspect, level, layer};
342 IMAGE_CMD_BUF_LAYOUT_NODE node;
343 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700344 return false;
345 }
346 bool skip = false;
347 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
348 // TODO: Set memory invalid which is in mem_tracker currently
349 } else if (node.layout != mem_barrier->oldLayout) {
350 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0,
351 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
352 "You cannot transition the layout of aspect %d from %s when current layout is %s.", aspect,
353 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
354 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700355 return skip;
356}
357
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700358void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
359 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
360 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
361 return;
362 }
363 VkImageSubresource sub = {aspect, level, layer};
364 IMAGE_CMD_BUF_LAYOUT_NODE node;
365 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
366 SetLayout(device_data, pCB, mem_barrier->image, sub,
367 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
368 return;
369 }
370 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
371 // TODO: Set memory invalid
372 }
373 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
374}
375
Mike Weiblen62d08a32017-03-07 22:18:27 -0700376// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
377bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
378 VkImageUsageFlags usage_flags, const char *func_name) {
379 const auto report_data = core_validation::GetReportData(device_data);
380 bool skip = false;
381 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
382 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
383
384 switch (layout) {
385 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
386 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
387 msg_code = VALIDATION_ERROR_00303;
388 }
389 break;
390 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
391 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
392 msg_code = VALIDATION_ERROR_00304;
393 }
394 break;
395 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
396 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
397 msg_code = VALIDATION_ERROR_00305;
398 }
399 break;
400 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
401 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
402 msg_code = VALIDATION_ERROR_00306;
403 }
404 break;
405 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
406 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
407 msg_code = VALIDATION_ERROR_00307;
408 }
409 break;
410 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
411 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
412 msg_code = VALIDATION_ERROR_00308;
413 }
414 break;
415 default:
416 // Other VkImageLayout values do not have VUs defined in this context.
417 break;
418 }
419
420 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
421 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, msg_code,
422 "DS", "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32
423 ". %s",
424 func_name, img_barrier, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
425 (uint64_t)(img_barrier->image), usage_flags, validation_error_map[msg_code]);
426 }
427 return skip;
428}
429
430// Verify image barriers are compatible with the images they reference.
431bool ValidateBarriersToImages(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t imageMemoryBarrierCount,
432 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700433 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700434 bool skip = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700435 uint32_t level_count = 0;
436 uint32_t layer_count = 0;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700437
Mike Weiblen62d08a32017-03-07 22:18:27 -0700438 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
439 auto img_barrier = &pImageMemoryBarriers[i];
440 if (!img_barrier) continue;
441
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700442 // TODO: Do not iterate over every possibility - consolidate where possible
Mike Weiblen62d08a32017-03-07 22:18:27 -0700443 ResolveRemainingLevelsLayers(device_data, &level_count, &layer_count, img_barrier->subresourceRange,
444 GetImageState(device_data, img_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700445
Mike Weiblen62d08a32017-03-07 22:18:27 -0700446 for (uint32_t j = 0; j < level_count; j++) {
447 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
448 for (uint32_t k = 0; k < layer_count; k++) {
449 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
450 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
451 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
452 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
453 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700454 }
455 }
Mike Weiblen62d08a32017-03-07 22:18:27 -0700456
457 IMAGE_STATE *image_state = GetImageState(device_data, img_barrier->image);
458 if (image_state) {
459 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
460 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
461 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
462 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700463 }
464 return skip;
465}
466
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700467void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
468 const VkImageMemoryBarrier *pImgMemBarriers) {
469 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
470 uint32_t levelCount = 0;
471 uint32_t layerCount = 0;
472
473 for (uint32_t i = 0; i < memBarrierCount; ++i) {
474 auto mem_barrier = &pImgMemBarriers[i];
475 if (!mem_barrier) continue;
476 // TODO: Do not iterate over every possibility - consolidate where possible
477 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
478 GetImageState(device_data, mem_barrier->image));
479
480 for (uint32_t j = 0; j < levelCount; j++) {
481 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
482 for (uint32_t k = 0; k < layerCount; k++) {
483 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
484 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
485 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
486 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
487 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
488 }
489 }
490 }
491}
492
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700493bool VerifySourceImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage srcImage, VkImageSubresourceLayers subLayers,
494 VkImageLayout srcImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700495 const auto report_data = core_validation::GetReportData(device_data);
496 bool skip_call = false;
497
498 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
499 uint32_t layer = i + subLayers.baseArrayLayer;
500 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
501 IMAGE_CMD_BUF_LAYOUT_NODE node;
502 if (!FindCmdBufLayout(device_data, cb_node, srcImage, sub, node)) {
503 SetLayout(device_data, cb_node, srcImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(srcImageLayout, srcImageLayout));
504 continue;
505 }
506 if (node.layout != srcImageLayout) {
507 // TODO: Improve log message in the next pass
508 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
509 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
510 "Cannot copy from an image whose source layout is %s "
511 "and doesn't match the current layout %s.",
512 string_VkImageLayout(srcImageLayout), string_VkImageLayout(node.layout));
513 }
514 }
515 if (srcImageLayout != VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) {
516 if (srcImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
517 // TODO : Can we deal with image node from the top of call tree and avoid map look-up here?
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700518 auto image_state = GetImageState(device_data, srcImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700519 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
520 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
521 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
522 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
523 "Layout for input image should be TRANSFER_SRC_OPTIMAL instead of GENERAL.");
524 }
525 } else {
526 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
527 "DS", "Layout for input image is %s but can only be TRANSFER_SRC_OPTIMAL or GENERAL. %s",
528 string_VkImageLayout(srcImageLayout), validation_error_map[msgCode]);
529 }
530 }
531 return skip_call;
532}
533
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700534bool VerifyDestImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage destImage, VkImageSubresourceLayers subLayers,
535 VkImageLayout destImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700536 const auto report_data = core_validation::GetReportData(device_data);
537 bool skip_call = false;
538
539 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
540 uint32_t layer = i + subLayers.baseArrayLayer;
541 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
542 IMAGE_CMD_BUF_LAYOUT_NODE node;
543 if (!FindCmdBufLayout(device_data, cb_node, destImage, sub, node)) {
544 SetLayout(device_data, cb_node, destImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(destImageLayout, destImageLayout));
545 continue;
546 }
547 if (node.layout != destImageLayout) {
548 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
549 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
550 "Cannot copy from an image whose dest layout is %s and "
551 "doesn't match the current layout %s.",
552 string_VkImageLayout(destImageLayout), string_VkImageLayout(node.layout));
553 }
554 }
555 if (destImageLayout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
556 if (destImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700557 auto image_state = GetImageState(device_data, destImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700558 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
559 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
560 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
561 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
562 "Layout for output image should be TRANSFER_DST_OPTIMAL instead of GENERAL.");
563 }
564 } else {
565 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
566 "DS", "Layout for output image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s",
567 string_VkImageLayout(destImageLayout), validation_error_map[msgCode]);
568 }
569 }
570 return skip_call;
571}
572
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700573void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
574 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700575 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700576 if (!renderPass) return;
577
578 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
579 if (framebuffer_state) {
580 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
581 auto image_view = framebuffer_state->createInfo.pAttachments[i];
582 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
583 }
584 }
585}
586
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700587bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700588 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
589 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700590 const debug_report_data *report_data = core_validation::GetReportData(device_data);
591
592 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700593 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700594
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700595 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700596 std::stringstream ss;
597 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
598 skip_call |=
599 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
600 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
601 }
602
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700603 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700604 std::stringstream ss;
605 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
606 skip_call |=
607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
608 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
609 }
610
611 // Validate that format supports usage as color attachment
612 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
613 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700614 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700615 std::stringstream ss;
616 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
617 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
618 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
619 __LINE__, VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(),
620 validation_error_map[VALIDATION_ERROR_02158]);
621 }
622 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700623 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700624 std::stringstream ss;
625 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
626 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
627 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
628 __LINE__, VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(),
629 validation_error_map[VALIDATION_ERROR_02153]);
630 }
631 }
632 // Validate that format supports usage as depth/stencil attachment
633 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
634 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700635 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700636 std::stringstream ss;
637 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
638 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
639 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
640 __LINE__, VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(),
641 validation_error_map[VALIDATION_ERROR_02159]);
642 }
643 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700644 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700645 std::stringstream ss;
646 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
647 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
648 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
649 __LINE__, VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(),
650 validation_error_map[VALIDATION_ERROR_02154]);
651 }
652 }
653 } else {
654 skip_call |=
655 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
656 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
657 validation_error_map[VALIDATION_ERROR_00715]);
658 }
659
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700660 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
661 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700662
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700663 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700664 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
665
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700666 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
667 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
668 VALIDATION_ERROR_00716, "Image",
669 "CreateImage extent is 0 for at least one required dimension for image: "
670 "Width = %d Height = %d Depth = %d. %s",
671 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
672 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700673 }
674
675 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
676 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700677 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
678 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
679 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700680 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
681 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
682 "CreateImage extents exceed allowable limits for format: "
683 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
684 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700685 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
686 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700687 }
688
689 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
690 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
691 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
692 (uint64_t)imageGranularity) &
693 ~(uint64_t)imageGranularity;
694
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700695 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700696 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
697 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
698 "CreateImage resource size exceeds allowable maximum "
699 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700700 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700701 }
702
703 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700704 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700705 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
706 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
707 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700708 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700709 }
710
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700711 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700712 skip_call |= log_msg(
713 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
714 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700715 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700716 }
717
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700718 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700719 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
720 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700721 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700722 validation_error_map[VALIDATION_ERROR_02138]);
723 }
724
725 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
726 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
727 VALIDATION_ERROR_00731, "Image",
728 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
729 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
730 validation_error_map[VALIDATION_ERROR_00731]);
731 }
732
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600733 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
734 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
735 VALIDATION_ERROR_02143, "DS",
736 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
737 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
738 validation_error_map[VALIDATION_ERROR_02143]);
739 }
740
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600741 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
742 skip_call |=
743 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
744 DRAWSTATE_INVALID_FEATURE, "DS",
745 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
746 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
747 }
748
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700749 return skip_call;
750}
751
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700752void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700753 IMAGE_LAYOUT_NODE image_state;
754 image_state.layout = pCreateInfo->initialLayout;
755 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700756 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 -0700757 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700758 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
759 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700760}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700761
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700762bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700763 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700764 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700765 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
766 if (disabled->destroy_image) return false;
767 bool skip = false;
768 if (*image_state) {
769 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
770 }
771 return skip;
772}
773
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700774void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700775 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
776 // Clean up memory mapping, bindings and range references for image
777 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700778 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700779 if (mem_info) {
780 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
781 }
782 }
783 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
784 // Remove image from imageMap
785 core_validation::GetImageMap(device_data)->erase(image);
786 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
787 core_validation::GetImageSubresourceMap(device_data);
788
789 const auto &sub_entry = imageSubresourceMap->find(image);
790 if (sub_entry != imageSubresourceMap->end()) {
791 for (const auto &pair : sub_entry->second) {
792 core_validation::GetImageLayoutMap(device_data)->erase(pair);
793 }
794 imageSubresourceMap->erase(sub_entry);
795 }
796}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700797
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700798bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700799 bool skip = false;
800 const debug_report_data *report_data = core_validation::GetReportData(device_data);
801
802 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
803 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
804 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
805 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
806 }
807
808 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
809 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
811 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
812 validation_error_map[VALIDATION_ERROR_01088]);
813 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
814 char const str[] = "vkCmdClearColorImage called with compressed image.";
815 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
816 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
817 validation_error_map[VALIDATION_ERROR_01088]);
818 }
819
820 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
821 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
822 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
823 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
824 validation_error_map[VALIDATION_ERROR_01084]);
825 }
826 return skip;
827}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700828
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700829void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700830 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
831 // internal state to the actual values.
832 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
833 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
834 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700835
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700836 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
837 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700838 }
839}
840
841// 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 -0700842void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
843 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700844 *levels = range.levelCount;
845 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700846 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
847 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
848 }
849 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
850 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700851 }
852}
853
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700854bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700855 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
856 bool skip = false;
857 const debug_report_data *report_data = core_validation::GetReportData(device_data);
858
859 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700860 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700861
862 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
863 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700864 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
865 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
866 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
867 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
868 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
869 }
870 } else {
871 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
872 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
873 error_code = VALIDATION_ERROR_01101;
874 } else {
875 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
876 }
877 skip |=
878 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, error_code, "DS",
879 "%s: Layout for cleared image is %s but can only be "
880 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
881 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
882 }
883 }
884
885 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
886 uint32_t level = level_index + resolved_range.baseMipLevel;
887 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
888 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
889 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
890 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700891 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700892 if (node.layout != dest_image_layout) {
893 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
894 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
895 error_code = VALIDATION_ERROR_01100;
896 } else {
897 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
898 }
899 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
900 __LINE__, error_code, "DS",
901 "%s: Cannot clear an image whose layout is %s and "
902 "doesn't match the current layout %s. %s",
903 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
904 validation_error_map[error_code]);
905 }
906 }
907 }
908 }
909
910 return skip;
911}
912
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700913void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
914 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700915 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700916 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700917
918 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
919 uint32_t level = level_index + resolved_range.baseMipLevel;
920 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
921 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
922 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
923 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700924 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
925 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 -0700926 }
927 }
928 }
929}
930
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700931bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700932 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
933 bool skip = false;
934 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700935 auto cb_node = GetCBNode(dev_data, commandBuffer);
936 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700937 if (cb_node && image_state) {
938 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
939 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
940 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
941 for (uint32_t i = 0; i < rangeCount; ++i) {
942 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700943 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700944 }
945 }
946 return skip;
947}
948
949// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700950void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
951 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700952 auto cb_node = GetCBNode(dev_data, commandBuffer);
953 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700954 if (cb_node && image_state) {
955 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
956 std::function<bool()> function = [=]() {
957 SetImageMemoryValid(dev_data, image_state, true);
958 return false;
959 };
960 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700961 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700962 for (uint32_t i = 0; i < rangeCount; ++i) {
963 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
964 }
965 }
966}
967
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700968bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
969 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700970 const VkImageSubresourceRange *pRanges) {
971 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700972 const debug_report_data *report_data = core_validation::GetReportData(device_data);
973
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700974 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700975 auto cb_node = GetCBNode(device_data, commandBuffer);
976 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700977 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700978 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
979 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
980 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700981 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700982 skip |=
983 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700984 // Image aspect must be depth or stencil or both
985 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
986 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
987 char const str[] =
988 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
989 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
990 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
991 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
992 }
993 }
994 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
995 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
996 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
997 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
998 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700999 }
1000 }
1001 return skip;
1002}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001003
1004// Returns true if [x, xoffset] and [y, yoffset] overlap
1005static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1006 bool result = false;
1007 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1008 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1009
1010 if (intersection_max > intersection_min) {
1011 result = true;
1012 }
1013 return result;
1014}
1015
1016// Returns true if two VkImageCopy structures overlap
1017static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1018 bool result = false;
1019 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1020 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1021 dst->dstSubresource.layerCount))) {
1022 result = true;
1023 switch (type) {
1024 case VK_IMAGE_TYPE_3D:
1025 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1026 // Intentionally fall through to 2D case
1027 case VK_IMAGE_TYPE_2D:
1028 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1029 // Intentionally fall through to 1D case
1030 case VK_IMAGE_TYPE_1D:
1031 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1032 break;
1033 default:
1034 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1035 assert(false);
1036 }
1037 }
1038 return result;
1039}
1040
1041// Returns true if offset and extent exceed image extents
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001042static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001043 bool result = false;
1044 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001045 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1046 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
1047 result = true;
1048 }
1049 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1050 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
1051 result = true;
1052 }
1053 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1054 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
1055 result = true;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001056 }
1057 return result;
1058}
1059
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001060// Test if two VkExtent3D structs are equivalent
1061static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1062 bool result = true;
1063 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1064 (extent->depth != other_extent->depth)) {
1065 result = false;
1066 }
1067 return result;
1068}
1069
1070// Returns the image extent of a specific subresource.
1071static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1072 const uint32_t mip = subresource->mipLevel;
1073 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001074 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
1075 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1076 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1077 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001078 return extent;
1079}
1080
1081// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001082static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001083 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1084}
1085
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001086// Test if the extent argument has any dimensions set to 0.
1087static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1088 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1089}
1090
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001091// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1092static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1093 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1094 VkExtent3D granularity = {0, 0, 0};
1095 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1096 if (pPool) {
1097 granularity =
1098 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
1099 if (vk_format_is_compressed(img->createInfo.format)) {
Mark Lobodzinski13086442017-02-24 08:53:14 -07001100 auto block_size = vk_format_compressed_texel_block_extents(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001101 granularity.width *= block_size.width;
1102 granularity.height *= block_size.height;
1103 }
1104 }
1105 return granularity;
1106}
1107
1108// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1109static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1110 bool valid = true;
1111 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
1112 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
1113 valid = false;
1114 }
1115 return valid;
1116}
1117
1118// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1119static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1120 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1121 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1122 bool skip = false;
1123 VkExtent3D offset_extent = {};
1124 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1125 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1126 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001127 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001128 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001129 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001130 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1131 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1132 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1133 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1134 function, i, member, offset->x, offset->y, offset->z);
1135 }
1136 } else {
1137 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1138 // integer multiples of the image transfer granularity.
1139 if (IsExtentAligned(&offset_extent, granularity) == false) {
1140 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1141 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1142 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1143 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1144 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1145 granularity->depth);
1146 }
1147 }
1148 return skip;
1149}
1150
1151// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1152static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1153 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1154 const uint32_t i, const char *function, const char *member) {
1155 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1156 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001157 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001158 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1159 // subresource extent.
1160 if (IsExtentEqual(extent, subresource_extent) == false) {
1161 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1162 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1163 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1164 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1165 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1166 subresource_extent->height, subresource_extent->depth);
1167 }
1168 } else {
1169 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1170 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1171 // subresource extent dimensions.
1172 VkExtent3D offset_extent_sum = {};
1173 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1174 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1175 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1176 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1177 skip |=
1178 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1179 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1180 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1181 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1182 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1183 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1184 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1185 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1186 }
1187 }
1188 return skip;
1189}
1190
1191// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1192static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1193 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1194 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1195
1196 bool skip = false;
1197 if (vk_safe_modulo(value, granularity) != 0) {
1198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1199 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1200 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1201 "transfer granularity width (%d).",
1202 function, i, member, value, granularity);
1203 }
1204 return skip;
1205}
1206
1207// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1208static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1209 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1210 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1211 bool skip = false;
1212 if (vk_safe_modulo(value, granularity) != 0) {
1213 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1214 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1215 "%s: pRegion[%d].%s (%" PRIdLEAST64
1216 ") must be an even integer multiple of this command buffer's queue family image transfer "
1217 "granularity width (%d).",
1218 function, i, member, value, granularity);
1219 }
1220 return skip;
1221}
1222
1223// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1224bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1225 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1226 const uint32_t i, const char *function) {
1227 bool skip = false;
1228 if (vk_format_is_compressed(img->createInfo.format) == true) {
1229 // TODO: Add granularity checking for compressed formats
1230
1231 // bufferRowLength must be a multiple of the compressed texel block width
1232 // bufferImageHeight must be a multiple of the compressed texel block height
1233 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1234 // bufferOffset must be a multiple of the compressed texel block size in bytes
1235 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1236 // must equal the image subresource width
1237 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1238 // must equal the image subresource height
1239 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1240 // must equal the image subresource depth
1241 } else {
1242 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1243 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1244 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1245 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1246 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1247 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1248 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1249 i, function, "imageExtent");
1250 }
1251 return skip;
1252}
1253
1254// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1255bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1256 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1257 const char *function) {
1258 bool skip = false;
1259 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1260 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1261 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1262 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1263 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1264 function, "extent");
1265 return skip;
1266}
1267
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001268bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001269 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1270 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001271 bool skip = false;
1272 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1273 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1274
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001275 for (uint32_t i = 0; i < region_count; i++) {
1276 if (regions[i].srcSubresource.layerCount == 0) {
1277 std::stringstream ss;
1278 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1279 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1280 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1281 ss.str().c_str());
1282 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001283
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001284 if (regions[i].dstSubresource.layerCount == 0) {
1285 std::stringstream ss;
1286 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1287 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1288 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1289 ss.str().c_str());
1290 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001291
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001292 // For each region the layerCount member of srcSubresource and dstSubresource must match
1293 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1294 std::stringstream ss;
1295 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1296 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1297 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1298 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1299 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001300
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001301 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1302 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1303 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1305 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1306 validation_error_map[VALIDATION_ERROR_01197]);
1307 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001308
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001309 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1310 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1311 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1312 std::stringstream ss;
1313 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1314 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1315 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1316 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1317 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001318
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001319 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1320 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1321 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1322 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1323 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1324 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1325 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1326 validation_error_map[VALIDATION_ERROR_01221]);
1327 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001328
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001329 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1330 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1331 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1332 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1333 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1334 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1335 std::stringstream ss;
1336 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1337 << "] baseArrayLayer was not zero or layerCount was not 1.";
1338 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1339 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1340 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1341 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001342
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001343 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1344 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1345 std::stringstream ss;
1346 ss << "vkCmdCopyImage: pRegions[" << i
1347 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1349 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1350 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1351 }
1352 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1353 std::stringstream ss;
1354 ss << "vkCmdCopyImage: pRegions[" << i
1355 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1356 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1357 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1358 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1359 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001360
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001361 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1362 // image was created
1363 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1364 src_image_state->createInfo.arrayLayers) {
1365 std::stringstream ss;
1366 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1367 << "] baseArrayLayer + layerCount is "
1368 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1369 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1370 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1371 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1372 }
1373 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1374 dst_image_state->createInfo.arrayLayers) {
1375 std::stringstream ss;
1376 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1377 << "] baseArrayLayer + layerCount is "
1378 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1379 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1380 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1381 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1382 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001383
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001384 // The source region specified by a given element of regions must be a region that is contained within srcImage
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001385 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &(src_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001386 std::stringstream ss;
1387 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1388 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1389 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1390 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1391 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001392
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001393 // The destination region specified by a given element of regions must be a region that is contained within dst_image
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001394 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &(dst_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001395 std::stringstream ss;
1396 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1397 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1398 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1399 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1400 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001401
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001402 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1403 // must not overlap in memory
1404 if (src_image_state->image == dst_image_state->image) {
1405 for (uint32_t j = 0; j < region_count; j++) {
1406 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1407 std::stringstream ss;
1408 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1410 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1411 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001412 }
1413 }
1414 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001415 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001416
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001417 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1418 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1419 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1420 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1421 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1422 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1423 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1424 skip |=
1425 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1426 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1427 }
1428 } else {
1429 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1430 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1431 if (srcSize != destSize) {
1432 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1434 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1435 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001436 }
1437 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001438
1439 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1440 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1441 // Validate that SRC & DST images have correct usage flags set
1442 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1443 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1444 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1445 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
1446 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1447 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1448 for (uint32_t i = 0; i < region_count; ++i) {
1449 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, regions[i].srcSubresource, src_image_layout,
1450 VALIDATION_ERROR_01180);
1451 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, regions[i].dstSubresource, dst_image_layout,
1452 VALIDATION_ERROR_01183);
1453 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1454 "vkCmdCopyImage()");
1455 }
1456
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001457 return skip;
1458}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001459
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001460void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1461 IMAGE_STATE *dst_image_state) {
1462 // Update bindings between images and cmd buffer
1463 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1464 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07001465 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001466 cb_node->validate_functions.push_back(function);
1467 function = [=]() {
1468 SetImageMemoryValid(device_data, dst_image_state, true);
1469 return false;
1470 };
1471 cb_node->validate_functions.push_back(function);
1472 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1473}
1474
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001475// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1476// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1477// to that same cmd buffer by separate thread are not changing state from underneath us
1478// Track the last cmd buffer touched by this thread
1479static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1480 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1481 if (pCB->drawCount[i]) return true;
1482 }
1483 return false;
1484}
1485
1486// Returns true if sub_rect is entirely contained within rect
1487static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1488 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1489 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1490 return false;
1491 return true;
1492}
1493
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001494bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1495 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001496 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001497 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1498
1499 bool skip = false;
1500 if (cb_node) {
1501 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001502 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001503 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1504 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1505 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1506 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001507 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
1508 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001509 skip |=
1510 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1511 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1512 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1513 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1514 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001515 }
1516 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1517 }
1518
1519 // Validate that attachment is in reference list of active subpass
1520 if (cb_node->activeRenderPass) {
1521 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1522 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001523 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001524
1525 for (uint32_t i = 0; i < attachmentCount; i++) {
1526 auto clear_desc = &pAttachments[i];
1527 VkImageView image_view = VK_NULL_HANDLE;
1528
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001529 if (0 == clear_desc->aspectMask) {
1530 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1531 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
1532 validation_error_map[VALIDATION_ERROR_01128]);
1533 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1534 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1535 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
1536 validation_error_map[VALIDATION_ERROR_01126]);
1537 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001538 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001539 skip |=
1540 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1541 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01114, "DS",
1542 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1543 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001544 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1545 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001546 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1547 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1548 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1549 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001550 } else {
1551 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001552 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001553 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001554 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1555 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1556 char const str[] =
1557 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1558 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1559 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
1560 validation_error_map[VALIDATION_ERROR_01125]);
1561 }
1562 } else { // Must be depth and/or stencil
1563 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1564 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1565 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1566 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1567 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
1568 validation_error_map[VALIDATION_ERROR_01127]);
1569 }
1570 if (!subpass_desc->pDepthStencilAttachment ||
1571 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1572 skip |= log_msg(
1573 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1574 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1575 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001576 } else {
1577 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1578 }
1579 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001580 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001581 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001582 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001583 // The rectangular region specified by a given element of pRects must be contained within the render area of
1584 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001585 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
1586 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
1587 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001588 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1589 __LINE__, VALIDATION_ERROR_01115, "DS",
1590 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1591 "the current render pass instance. %s",
1592 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001593 }
1594 // The layers specified by a given element of pRects must be contained within every attachment that
1595 // pAttachments refers to
1596 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1597 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1598 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1599 skip |=
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001600 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1601 __LINE__, VALIDATION_ERROR_01116, "DS",
1602 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1603 "pAttachment[%d]. %s",
1604 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001605 }
1606 }
1607 }
1608 }
1609 }
1610 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001611}
1612
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001613bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001614 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001615 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001616 bool skip = false;
1617 if (cb_node && src_image_state && dst_image_state) {
1618 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1619 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
1620 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1621 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001622
1623 // For each region, the number of layers in the image subresource should not be zero
1624 // For each region, src and dest image aspect must be color only
1625 for (uint32_t i = 0; i < regionCount; i++) {
1626 if (pRegions[i].srcSubresource.layerCount == 0) {
1627 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001628 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 -07001629 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1630 "IMAGE", str);
1631 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001632 if (pRegions[i].dstSubresource.layerCount == 0) {
1633 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001634 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 -07001635 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1636 "IMAGE", str);
1637 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001638 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1639 skip |= log_msg(
1640 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1641 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1642 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1643 validation_error_map[VALIDATION_ERROR_01339]);
1644 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001645 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1646 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1647 char const str[] =
1648 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1649 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1650 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1651 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1652 }
1653 }
1654
1655 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1656 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001657 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 -07001658 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1659 "IMAGE", str);
1660 }
1661 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1662 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001663 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 -07001664 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1665 str);
1666 }
1667 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1668 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1669 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1670 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1671 str, validation_error_map[VALIDATION_ERROR_01320]);
1672 }
1673 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1674 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1675 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1676 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1677 str, validation_error_map[VALIDATION_ERROR_01321]);
1678 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001679 } else {
1680 assert(0);
1681 }
1682 return skip;
1683}
1684
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001685void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1686 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001687 // Update bindings between images and cmd buffer
1688 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1689 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1690
1691 std::function<bool()> function = [=]() {
1692 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1693 };
1694 cb_node->validate_functions.push_back(function);
1695 function = [=]() {
1696 SetImageMemoryValid(device_data, dst_image_state, true);
1697 return false;
1698 };
1699 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001700 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001701}
1702
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001703bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001704 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1705 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1706
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001707 bool skip = false;
1708 if (cb_node && src_image_state && dst_image_state) {
1709 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001710 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001711 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001712 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001713 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1714 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1715 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001716 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001717 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001718 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001719 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1720 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001721
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001722 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001723 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001724 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1725 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1726 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1727 std::stringstream ss;
1728 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1729 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1730 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1731 "%s", ss.str().c_str());
1732 }
1733 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1734 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1735 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1736 std::stringstream ss;
1737 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1738 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1739 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1740 "%s", ss.str().c_str());
1741 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001742 if (pRegions[i].srcSubresource.layerCount == 0) {
1743 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1744 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltoneba86e22017-03-02 14:56:23 -07001745 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1746 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001747 }
1748 if (pRegions[i].dstSubresource.layerCount == 0) {
1749 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1750 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltoneba86e22017-03-02 14:56:23 -07001751 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1752 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001753 }
1754
1755 // Check that src/dst layercounts match
1756 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1757 skip |=
1758 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1759 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1760 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1761 i, validation_error_map[VALIDATION_ERROR_01304]);
1762 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001763
1764 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1765 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1766 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1767 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1768 validation_error_map[VALIDATION_ERROR_01303]);
1769 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001770 }
1771
1772 VkFormat src_format = src_image_state->createInfo.format;
1773 VkFormat dst_format = dst_image_state->createInfo.format;
1774
1775 // Validate consistency for unsigned formats
1776 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1777 std::stringstream ss;
1778 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1779 << "the other one must also have unsigned integer format. "
1780 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1781 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1782 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1783 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1784 }
1785
1786 // Validate consistency for signed formats
1787 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1788 std::stringstream ss;
1789 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1790 << "the other one must also have signed integer format. "
1791 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1793 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1794 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1795 }
1796
1797 // Validate aspect bits and formats for depth/stencil images
1798 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
1799 if (src_format != dst_format) {
1800 std::stringstream ss;
1801 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1802 << "stencil, the other one must have exactly the same format. "
1803 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1804 << string_VkFormat(dst_format);
1805 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1806 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1807 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1808 }
1809
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001810 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001811 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001812
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001813 if (vk_format_is_depth_and_stencil(src_format)) {
1814 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1815 std::stringstream ss;
1816 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1817 "VK_IMAGE_ASPECT_DEPTH_BIT "
1818 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1820 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1821 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1822 }
1823 } else if (vk_format_is_stencil_only(src_format)) {
1824 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1825 std::stringstream ss;
1826 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1827 << "set in both the srcImage and dstImage";
1828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1829 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1830 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1831 }
1832 } else if (vk_format_is_depth_only(src_format)) {
1833 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1834 std::stringstream ss;
1835 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1836 << "set in both the srcImage and dstImage";
1837 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1838 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1839 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1840 }
1841 }
1842 }
1843 }
1844
1845 // Validate filter
1846 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1847 std::stringstream ss;
1848 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1849 << "then filter must be VK_FILTER_NEAREST.";
1850 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1851 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1852 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1853 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001854 } else {
1855 assert(0);
1856 }
1857 return skip;
1858}
1859
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001860void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1861 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001862 // Update bindings between images and cmd buffer
1863 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1864 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1865
1866 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1867 cb_node->validate_functions.push_back(function);
1868 function = [=]() {
1869 SetImageMemoryValid(device_data, dst_image_state, true);
1870 return false;
1871 };
1872 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001873 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001874}
1875
Tony Barbourdf013b92017-01-25 12:53:48 -07001876// This validates that the initial layout specified in the command buffer for
1877// the IMAGE is the same
1878// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001879bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1880 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001881 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001882 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001883 for (auto cb_image_data : pCB->imageLayoutMap) {
1884 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001885
Jeremy Hayes55b6c292017-02-28 09:44:45 -07001886 if (FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001887 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1888 // TODO: Set memory invalid which is in mem_tracker currently
1889 } else if (imageLayout != cb_image_data.second.initialLayout) {
1890 if (cb_image_data.first.hasSubresource) {
Dave Houltoneba86e22017-03-02 14:56:23 -07001891 skip |= log_msg(
1892 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1893 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1894 "Cannot submit cmd buffer using image (0x%" PRIx64
1895 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1896 "with layout %s when first use is %s.",
1897 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
1898 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
1899 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001900 } else {
Dave Houltoneba86e22017-03-02 14:56:23 -07001901 skip |=
1902 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1903 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1904 "Cannot submit cmd buffer using image (0x%" PRIx64
1905 ") with layout %s when "
1906 "first use is %s.",
1907 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), string_VkImageLayout(imageLayout),
1908 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001909 }
1910 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001911 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001912 }
1913 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001914 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001915}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001916
Tony Barbourdf013b92017-01-25 12:53:48 -07001917void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1918 for (auto cb_image_data : pCB->imageLayoutMap) {
1919 VkImageLayout imageLayout;
1920 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1921 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1922 }
1923}
1924
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001925// Print readable FlagBits in FlagMask
1926static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1927 std::string result;
1928 std::string separator;
1929
1930 if (accessMask == 0) {
1931 result = "[None]";
1932 } else {
1933 result = "[";
1934 for (auto i = 0; i < 32; i++) {
1935 if (accessMask & (1 << i)) {
1936 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1937 separator = " | ";
1938 }
1939 }
1940 result = result + "]";
1941 }
1942 return result;
1943}
1944
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001945// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1946// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001947// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001948static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
1949 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
1950 const char *type) {
1951 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1952 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001953
1954 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
1955 if (accessMask & ~(required_bit | optional_bits)) {
1956 // TODO: Verify against Valid Use
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001957 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1958 DRAWSTATE_INVALID_BARRIER, "DS",
1959 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1960 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001961 }
1962 } else {
1963 if (!required_bit) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001964 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1965 DRAWSTATE_INVALID_BARRIER, "DS",
1966 "%s AccessMask %d %s must contain at least one of access bits %d "
1967 "%s when layout is %s, unless the app has previously added a "
1968 "barrier for this transition.",
1969 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
1970 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001971 } else {
1972 std::string opt_bits;
1973 if (optional_bits != 0) {
1974 std::stringstream ss;
1975 ss << optional_bits;
1976 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
1977 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001978 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1979 DRAWSTATE_INVALID_BARRIER, "DS",
1980 "%s AccessMask %d %s must have required access bit %d %s %s when "
1981 "layout is %s, unless the app has previously added a barrier for "
1982 "this transition.",
1983 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
1984 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001985 }
1986 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001987 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001988}
1989
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001990bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
1991 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
1992 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001993
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001994 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001995 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001996 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
1997 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
1998 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
1999 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002000 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002001 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
2002 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
2003 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2004 break;
2005 }
2006 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
2007 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
2008 break;
2009 }
2010 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
2011 skip |= ValidateMaskBits(
2012 device_data, cmdBuffer, accessMask, layout, 0,
2013 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
2014 type);
2015 break;
2016 }
2017 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
2018 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
2019 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
2020 break;
2021 }
2022 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
2023 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
2024 break;
2025 }
2026 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
2027 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
2028 break;
2029 }
2030 case VK_IMAGE_LAYOUT_UNDEFINED: {
2031 if (accessMask != 0) {
2032 // TODO: Verify against Valid Use section spec
2033 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2034 DRAWSTATE_INVALID_BARRIER, "DS",
2035 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2036 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
2037 }
2038 break;
2039 }
2040 case VK_IMAGE_LAYOUT_GENERAL:
2041 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002042 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002043 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002044}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002045
2046// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002047// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2048// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002049bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002050 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2051 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002052 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2053 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2054 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2055 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002056 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
2057 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
2058 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
2059 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002060 }
2061 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002062 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002063}
2064
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002065bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2066 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002067 bool skip = false;
2068
2069 // Track when we're observing the first use of an attachment
2070 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2071 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2072 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
2073 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2074 auto attach_index = subpass.pColorAttachments[j].attachment;
2075 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2076
2077 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002078 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
2079 // This is ideal.
2080 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002081
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002082 case VK_IMAGE_LAYOUT_GENERAL:
2083 // May not be optimal; TODO: reconsider this warning based on other constraints?
2084 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2085 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2086 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2087 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002088
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002089 default:
2090 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2091 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2092 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2093 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002094 }
2095
2096 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002097 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2098 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002099 }
2100 attach_first_use[attach_index] = false;
2101 }
2102 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2103 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002104 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2105 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2106 // These are ideal.
2107 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002108
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002109 case VK_IMAGE_LAYOUT_GENERAL:
2110 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2111 // doing a bunch of transitions.
2112 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2113 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2114 "GENERAL layout for depth attachment may not give optimal performance.");
2115 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002116
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002117 default:
2118 // No other layouts are acceptable
2119 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2120 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2121 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2122 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2123 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002124 }
2125
2126 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2127 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002128 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2129 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002130 }
2131 attach_first_use[attach_index] = false;
2132 }
2133 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2134 auto attach_index = subpass.pInputAttachments[j].attachment;
2135 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2136
2137 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002138 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2139 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2140 // These are ideal.
2141 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002142
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002143 case VK_IMAGE_LAYOUT_GENERAL:
2144 // May not be optimal. TODO: reconsider this warning based on other constraints.
2145 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2146 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2147 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2148 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002149
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002150 default:
2151 // No other layouts are acceptable
2152 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2153 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2154 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2155 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002156 }
2157
2158 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002159 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2160 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002161 }
2162 attach_first_use[attach_index] = false;
2163 }
2164 }
2165 return skip;
2166}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002167
2168// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002169bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2170 VkDeviceSize offset, VkDeviceSize end_offset) {
2171 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2172 bool skip = false;
2173 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2174 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002175 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2176 for (auto image_handle : mem_info->bound_images) {
2177 auto img_it = mem_info->bound_ranges.find(image_handle);
2178 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002179 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002180 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002181 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002182 for (auto layout : layouts) {
2183 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Dave Houltoneba86e22017-03-02 14:56:23 -07002184 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
2185 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Michael Lentinec174b932017-02-10 14:57:15 -06002186 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2187 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002188 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002189 }
2190 }
2191 }
2192 }
2193 }
2194 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002195 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002196}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002197
2198// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2199// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002200static 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 -07002201 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2202 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002203 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002204
2205 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002206 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002207 if (strict) {
2208 correct_usage = ((actual & desired) == desired);
2209 } else {
2210 correct_usage = ((actual & desired) != 0);
2211 }
2212 if (!correct_usage) {
2213 if (msgCode == -1) {
2214 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltoneba86e22017-03-02 14:56:23 -07002215 skip = log_msg(
2216 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2217 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation.",
2218 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002219 } else {
2220 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002221 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2222 "Invalid usage flag for %s 0x%" PRIxLEAST64
2223 " used by %s. In this case, %s should have %s set during creation. %s",
2224 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002225 }
2226 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002227 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002228}
2229
2230// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2231// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002232bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002233 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002234 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002235 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2236 msgCode, "image", func_name, usage_string);
2237}
2238
2239// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2240// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002241bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002242 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002243 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002244 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2245 msgCode, "buffer", func_name, usage_string);
2246}
2247
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002248bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002249 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002250 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2251
Mark Lobodzinski96210742017-02-09 10:33:46 -07002252 // TODO: Add check for VALIDATION_ERROR_00658
Mark Lobodzinski96210742017-02-09 10:33:46 -07002253 // TODO: Add check for VALIDATION_ERROR_00667
2254 // TODO: Add check for VALIDATION_ERROR_00668
2255 // TODO: Add check for VALIDATION_ERROR_00669
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002256
2257 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
2258 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2259 VALIDATION_ERROR_00666, "DS",
2260 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
2261 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
2262 validation_error_map[VALIDATION_ERROR_00666]);
2263 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06002264
2265 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
2266 skip |=
2267 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2268 DRAWSTATE_INVALID_FEATURE, "DS",
2269 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
2270 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
2271 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06002272
2273 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
2274 skip |=
2275 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2276 DRAWSTATE_INVALID_FEATURE, "DS",
2277 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
2278 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
2279 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07002280 return skip;
2281}
2282
2283void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2284 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2285 GetBufferMap(device_data)
2286 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2287}
2288
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002289bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2290 bool skip = false;
2291 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002292 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2293 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002294 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002295 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2296 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002297 skip |= ValidateBufferUsageFlags(
2298 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 -07002299 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2300 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002301 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002302}
2303
2304void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2305 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2306}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002307
2308// For the given format verify that the aspect masks make sense
2309bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2310 const char *func_name) {
2311 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2312 bool skip = false;
2313 if (vk_format_is_color(format)) {
2314 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2315 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2316 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2317 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2318 validation_error_map[VALIDATION_ERROR_00741]);
2319 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2320 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2321 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2322 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2323 validation_error_map[VALIDATION_ERROR_00741]);
2324 }
2325 } else if (vk_format_is_depth_and_stencil(format)) {
2326 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2327 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2328 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2329 "%s: Depth/stencil image formats must have "
2330 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2331 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2332 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2333 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
2334 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2335 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2336 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2337 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2338 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2339 }
2340 } else if (vk_format_is_depth_only(format)) {
2341 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2342 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2343 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2344 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2345 validation_error_map[VALIDATION_ERROR_00741]);
2346 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2347 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2348 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2349 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2350 validation_error_map[VALIDATION_ERROR_00741]);
2351 }
2352 } else if (vk_format_is_stencil_only(format)) {
2353 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2354 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2355 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2356 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2357 validation_error_map[VALIDATION_ERROR_00741]);
2358 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2359 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2360 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2361 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2362 validation_error_map[VALIDATION_ERROR_00741]);
2363 }
2364 }
2365 return skip;
2366}
2367
2368bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2369 const char *func_name) {
2370 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2371 bool skip = false;
2372 if (subresourceRange.levelCount == 0) {
2373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2374 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2375 validation_error_map[VALIDATION_ERROR_00768]);
2376 }
2377 if (subresourceRange.layerCount == 0) {
2378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2379 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2380 validation_error_map[VALIDATION_ERROR_00769]);
2381 }
2382 return skip;
2383}
2384
2385bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2386 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2387 bool skip = false;
2388 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2389 if (image_state) {
2390 skip |= ValidateImageUsageFlags(
2391 device_data, image_state,
2392 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2393 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2394 false, -1, "vkCreateImageView()",
2395 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2396 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2397 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2398 // Checks imported from image layer
2399 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2400 std::stringstream ss;
2401 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2402 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2403 skip |=
2404 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2405 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2406 }
2407 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2408 std::stringstream ss;
2409 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2410 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2411 skip |=
2412 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2413 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2414 }
2415 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2416 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2417
2418 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2419 VkFormat image_format = image_state->createInfo.format;
2420 VkFormat view_format = create_info->format;
2421 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2422
2423 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2424 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2425 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2426 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2427 std::stringstream ss;
2428 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2429 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2430 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2431 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
2432 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2433 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2434 validation_error_map[VALIDATION_ERROR_02171]);
2435 }
2436 } else {
2437 // Format MUST be IDENTICAL to the format the image was created with
2438 if (image_format != view_format) {
2439 std::stringstream ss;
2440 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2441 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2442 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
2443 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2444 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2445 validation_error_map[VALIDATION_ERROR_02172]);
2446 }
2447 }
2448
2449 // Validate correct image aspect bits for desired formats and format consistency
2450 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2451 }
2452 return skip;
2453}
2454
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002455void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2456 auto image_view_map = GetImageViewMap(device_data);
2457 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2458
2459 auto image_state = GetImageState(device_data, create_info->image);
Petr Kraus87d3d112017-03-12 14:00:50 +01002460 auto& sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002461 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002462}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002463
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002464bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2465 BUFFER_STATE *dst_buffer_state) {
2466 bool skip = false;
2467 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2468 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2469 // Validate that SRC & DST buffers have correct usage flags set
2470 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2471 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2472 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2473 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2474 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2475 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2476 return skip;
2477}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002478
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002479void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2480 BUFFER_STATE *dst_buffer_state) {
2481 // Update bindings between buffers and cmd buffer
2482 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2483 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2484
2485 std::function<bool()> function = [=]() {
2486 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2487 };
2488 cb_node->validate_functions.push_back(function);
2489 function = [=]() {
2490 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2491 return false;
2492 };
2493 cb_node->validate_functions.push_back(function);
2494 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2495}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002496
2497static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2498 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2499 bool skip = false;
2500 auto buffer_state = GetBufferState(device_data, buffer);
2501 if (!buffer_state) {
2502 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2503 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2504 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2505 } else {
2506 if (buffer_state->in_use.load()) {
2507 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2508 __LINE__, VALIDATION_ERROR_00676, "DS",
2509 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2510 validation_error_map[VALIDATION_ERROR_00676]);
2511 }
2512 }
2513 return skip;
2514}
2515
2516bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2517 VK_OBJECT *obj_struct) {
2518 *image_view_state = GetImageViewState(device_data, image_view);
2519 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2520 if (GetDisables(device_data)->destroy_image_view) return false;
2521 bool skip = false;
2522 if (*image_view_state) {
2523 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2524 }
2525 return skip;
2526}
2527
2528void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2529 VK_OBJECT obj_struct) {
2530 // Any bound cmd buffers are now invalid
2531 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2532 (*GetImageViewMap(device_data)).erase(image_view);
2533}
2534
2535bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2536 *buffer_state = GetBufferState(device_data, buffer);
2537 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2538 if (GetDisables(device_data)->destroy_buffer) return false;
2539 bool skip = false;
2540 if (*buffer_state) {
2541 skip |= validateIdleBuffer(device_data, buffer);
2542 }
2543 return skip;
2544}
2545
2546void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2547 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2548 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2549 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2550 if (mem_info) {
2551 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2552 }
2553 }
2554 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2555 GetBufferMap(device_data)->erase(buffer_state->buffer);
2556}
2557
2558bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2559 VK_OBJECT *obj_struct) {
2560 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2561 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2562 if (GetDisables(device_data)->destroy_buffer_view) return false;
2563 bool skip = false;
2564 if (*buffer_view_state) {
2565 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2566 }
2567 return skip;
2568}
2569
2570void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2571 VK_OBJECT obj_struct) {
2572 // Any bound cmd buffers are now invalid
2573 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2574 GetBufferViewMap(device_data)->erase(buffer_view);
2575}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002576
2577bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2578 bool skip = false;
2579 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
2580 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2581 // Validate that DST buffer has correct usage flags set
2582 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2583 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2584 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2585 return skip;
2586}
2587
2588void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2589 std::function<bool()> function = [=]() {
2590 SetBufferMemoryValid(device_data, buffer_state, true);
2591 return false;
2592 };
2593 cb_node->validate_functions.push_back(function);
2594 // Update bindings between buffer and cmd buffer
2595 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2596 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2597}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002598
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002599bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2600 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002601 bool skip = false;
2602
2603 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002604 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
2605 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002606 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002607 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
2608 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2609 "must be 0 and 1, respectively. %s",
2610 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2611 validation_error_map[VALIDATION_ERROR_01746]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002612 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002613 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002614
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002615 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
2616 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002617 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002618 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
2619 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2620 "must be 0 and 1, respectively. %s",
2621 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2622 validation_error_map[VALIDATION_ERROR_01747]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002623 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002624 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002625
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002626 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2627 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2628 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2629 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
2630 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2631 "%d. For 3D images these must be 0 and 1, respectively. %s",
2632 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
2633 validation_error_map[VALIDATION_ERROR_01281]);
2634 }
2635 }
2636
2637 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2638 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
2639 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2640 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
2641 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2642 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2643 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
2644 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2645 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2646 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2647 }
2648
2649 // BufferOffset must be a multiple of 4
2650 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2651 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2652 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
2653 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2654 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2655 }
2656
2657 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2658 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2659 skip |= log_msg(
2660 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2661 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
2662 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2663 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2664 validation_error_map[VALIDATION_ERROR_01265]);
2665 }
2666
2667 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2668 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2669 skip |= log_msg(
2670 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2671 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
2672 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2673 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2674 validation_error_map[VALIDATION_ERROR_01266]);
2675 }
2676
2677 // subresource aspectMask must have exactly 1 bit set
2678 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2679 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2680 if (aspect_mask_bits.count() != 1) {
2681 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2682 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
2683 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2684 validation_error_map[VALIDATION_ERROR_01280]);
2685 }
2686
2687 // image subresource aspect bit must match format
2688 if (((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT)) &&
2689 (!vk_format_is_color(image_state->createInfo.format))) ||
2690 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT)) &&
2691 (!vk_format_has_depth(image_state->createInfo.format))) ||
2692 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2693 (!vk_format_has_stencil(image_state->createInfo.format)))) {
2694 skip |= log_msg(
2695 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2696 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
2697 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
2698 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
2699 validation_error_map[VALIDATION_ERROR_01279]);
2700 }
2701
2702 // Checks that apply only to compressed images
2703 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2704 // reserves a place for these compressed image checks. This block of code could move there once the image
2705 // stuff is moved into core validation.
2706 if (vk_format_is_compressed(image_state->createInfo.format)) {
2707 auto block_size = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2708
2709 // BufferRowLength must be a multiple of block width
2710 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002711 skip |= log_msg(
2712 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002713 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
2714 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2715 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002716 }
2717
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002718 // BufferRowHeight must be a multiple of block height
2719 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002720 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002721 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
2722 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2723 "height (%d). %s.",
2724 function, i, pRegions[i].bufferImageHeight, block_size.height,
2725 validation_error_map[VALIDATION_ERROR_01272]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002726 }
2727
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002728 // image offsets must be multiples of block dimensions
2729 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
Dave Houlton75967fc2017-03-06 17:21:16 -07002730 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
2731 (vk_safe_modulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002732 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2733 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
2734 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2735 "width & height (%d, %d). %s.",
2736 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2737 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002738 }
2739
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002740 // bufferOffset must be a multiple of block size (linear bytes)
2741 size_t block_size_in_bytes = vk_format_get_size(image_state->createInfo.format);
2742 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
2743 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2744 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01274, "IMAGE",
2745 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
2746 ") must be a multiple of the compressed image's texel block "
2747 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
2748 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2749 validation_error_map[VALIDATION_ERROR_01274]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002750 }
Dave Houlton67e9b532017-03-02 17:00:10 -07002751
2752 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07002753 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton67e9b532017-03-02 17:00:10 -07002754 if ((vk_safe_modulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002755 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
2756 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2757 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01275, "IMAGE",
2758 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
2759 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
2760 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
2761 mip_extent.width, validation_error_map[VALIDATION_ERROR_01275]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002762 }
2763
2764 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
2765 if ((vk_safe_modulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002766 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
2767 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2768 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01276, "IMAGE",
2769 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
2770 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
2771 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
2772 mip_extent.height, validation_error_map[VALIDATION_ERROR_01276]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002773 }
2774
2775 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
2776 if ((vk_safe_modulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002777 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
2778 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2779 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01277, "IMAGE",
2780 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
2781 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
2782 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
2783 mip_extent.depth, validation_error_map[VALIDATION_ERROR_01277]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002784 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002785 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002786 }
2787
2788 return skip;
2789}
2790
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002791static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
2792 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002793 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002794 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002795
2796 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002797 VkExtent3D extent = pRegions[i].imageExtent;
2798 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002799
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002800 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
2801 {
2802 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2803 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
2804 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
2805 extent.height, extent.depth);
2806 }
2807
2808 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
2809
2810 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002811 if (vk_format_is_compressed(image_info->format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002812 auto block_extent = vk_format_compressed_texel_block_extents(image_info->format);
2813 if (image_extent.width % block_extent.width) {
2814 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
2815 }
2816 if (image_extent.height % block_extent.height) {
2817 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
2818 }
2819 if (image_extent.depth % block_extent.depth) {
2820 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
2821 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002822 }
2823
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002824 if (ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002825 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002826 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002827 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002828 }
2829 }
2830
2831 return skip;
2832}
2833
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002834static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2835 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2836 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2837 bool skip = false;
2838
2839 VkDeviceSize buffer_size = buff_state->createInfo.size;
2840
2841 for (uint32_t i = 0; i < regionCount; i++) {
2842 VkExtent3D copy_extent = pRegions[i].imageExtent;
2843
2844 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2845 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2846 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2847
Dave Houltonf3229d52017-02-21 15:59:08 -07002848 // Handle special buffer packing rules for specific depth/stencil formats
2849 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2850 unit_size = vk_format_get_size(VK_FORMAT_S8_UINT);
2851 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2852 switch (image_state->createInfo.format) {
2853 case VK_FORMAT_D16_UNORM_S8_UINT:
2854 unit_size = vk_format_get_size(VK_FORMAT_D16_UNORM);
2855 break;
2856 case VK_FORMAT_D32_SFLOAT_S8_UINT:
2857 unit_size = vk_format_get_size(VK_FORMAT_D32_SFLOAT);
2858 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002859 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07002860 case VK_FORMAT_D24_UNORM_S8_UINT:
2861 unit_size = 4;
2862 break;
2863 default:
2864 break;
2865 }
2866 }
2867
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002868 if (vk_format_is_compressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002869 // Switch to texel block units, rounding up for any partially-used blocks
2870 auto block_dim = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2871 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
2872 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
2873
2874 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
2875 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
2876 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002877 }
2878
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002879 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
2880 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2881 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
2882 // TODO: Issure warning here? Already warned in ValidateImageBounds()...
2883 } else {
2884 // Calculate buffer offset of final copied byte, + 1.
2885 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
2886 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2887 max_buffer_offset *= unit_size; // convert to bytes
2888 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002889
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002890 if (buffer_size < max_buffer_offset) {
2891 skip |=
2892 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2893 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
2894 i, buffer_size, validation_error_map[msg_code]);
2895 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002896 }
2897 }
2898
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002899 return skip;
2900}
2901
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002902bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002903 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002904 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002905 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2906 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2907
2908 // Validate command buffer state
2909 if (CB_RECORDING != cb_node->state) {
2910 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2911 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2912 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2913 validation_error_map[VALIDATION_ERROR_01258]);
2914 } else {
2915 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2916 }
2917
2918 // Command pool must support graphics, compute, or transfer operations
2919 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2920
2921 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2922 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2923 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2924 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2925 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2926 "or transfer capabilities. %s.",
2927 validation_error_map[VALIDATION_ERROR_01259]);
2928 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002929 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002930 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002931 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002932 VALIDATION_ERROR_01246);
2933
2934 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2935 VALIDATION_ERROR_01249);
2936 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002937 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002938
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002939 // Validate that SRC image & DST buffer have correct usage flags set
2940 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2941 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002942 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002943 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002944 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
2945 for (uint32_t i = 0; i < regionCount; ++i) {
2946 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, pRegions[i].imageSubresource, srcImageLayout,
2947 VALIDATION_ERROR_01251);
2948 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
2949 "CmdCopyImageToBuffer");
2950 }
2951 return skip;
2952}
2953
2954void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002955 BUFFER_STATE *dst_buffer_state) {
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002956 // Update bindings between buffer/image and cmd buffer
2957 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002958 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002959
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002960 std::function<bool()> function = [=]() {
2961 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
2962 };
2963 cb_node->validate_functions.push_back(function);
2964 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002965 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002966 return false;
2967 };
2968 cb_node->validate_functions.push_back(function);
2969
2970 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002971}
2972
2973bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002974 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002975 const VkBufferImageCopy *pRegions, const char *func_name) {
2976 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2977 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
2978
2979 // Validate command buffer state
2980 if (CB_RECORDING != cb_node->state) {
2981 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2982 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
2983 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
2984 validation_error_map[VALIDATION_ERROR_01240]);
2985 } else {
2986 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
2987 }
2988
2989 // Command pool must support graphics, compute, or transfer operations
2990 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2991 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2992 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2993 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2994 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
2995 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
2996 "or transfer capabilities. %s.",
2997 validation_error_map[VALIDATION_ERROR_01241]);
2998 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002999 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003000 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003001 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003002 VALIDATION_ERROR_01227);
3003 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
3004 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003005 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003006 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003007 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003008 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3009 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
3010 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003011 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
3012 for (uint32_t i = 0; i < regionCount; ++i) {
3013 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, pRegions[i].imageSubresource, dstImageLayout,
3014 VALIDATION_ERROR_01234);
3015 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
3016 "vkCmdCopyBufferToImage()");
3017 }
3018 return skip;
3019}
3020
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003021void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003022 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003023 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003024 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003025 std::function<bool()> function = [=]() {
3026 SetImageMemoryValid(device_data, dst_image_state, true);
3027 return false;
3028 };
3029 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003030 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003031 cb_node->validate_functions.push_back(function);
3032
3033 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003034}
Mike Weiblen672b58b2017-02-21 14:32:53 -07003035
3036bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
3037 const auto report_data = core_validation::GetReportData(device_data);
3038 bool skip = false;
3039 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
3040
3041 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
3042 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
3043 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
3044 if (aspect_mask_bits.count() != 1) {
3045 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3046 VALIDATION_ERROR_00733, "IMAGE",
3047 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
3048 validation_error_map[VALIDATION_ERROR_00733]);
3049 }
3050
3051 IMAGE_STATE *image_entry = GetImageState(device_data, image);
3052 if (!image_entry) {
3053 return skip;
3054 }
3055
3056 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
3057 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
3058 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3059 __LINE__, VALIDATION_ERROR_00732, "IMAGE",
3060 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
3061 validation_error_map[VALIDATION_ERROR_00732]);
3062 }
3063
3064 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
3065 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
3066 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3067 __LINE__, VALIDATION_ERROR_00739, "IMAGE",
3068 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
3069 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
3070 }
3071
3072 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
3073 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
3074 skip |= log_msg(
3075 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
3076 VALIDATION_ERROR_00740, "IMAGE", "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
3077 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
3078 }
3079
3080 // VU 00741: subresource's aspect must be compatible with image's format.
3081 const VkFormat img_format = image_entry->createInfo.format;
3082 if (vk_format_is_color(img_format)) {
3083 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
3084 skip |= log_msg(
3085 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
3086 VALIDATION_ERROR_00741, "IMAGE",
3087 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
3088 validation_error_map[VALIDATION_ERROR_00741]);
3089 }
3090 } else if (vk_format_is_depth_or_stencil(img_format)) {
3091 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
3092 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3093 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
3094 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
3095 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
3096 validation_error_map[VALIDATION_ERROR_00741]);
3097 }
3098 }
3099 return skip;
3100}