blob: ef777d76dcf12bc2fd3eccd27ea0df905de5a411 [file] [log] [blame]
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07001/* Copyright (c) 2015-2017 The Khronos Group Inc.
2 * Copyright (c) 2015-2017 Valve Corporation
3 * Copyright (c) 2015-2017 LunarG, Inc.
4 * Copyright (C) 2015-2017 Google Inc.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
19 */
20
21// Allow use of STL min and max functions in Windows
22#define NOMINMAX
23
Mark Lobodzinski90224de2017-01-26 15:23:11 -070024#include <sstream>
25
26#include "vk_enum_string_helper.h"
27#include "vk_layer_data.h"
28#include "vk_layer_utils.h"
29#include "vk_layer_logging.h"
30
31
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070032#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070033
Tobin Ehlis58c884f2017-02-08 12:15:27 -070034void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070035 if (std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair) !=
36 pCB->imageSubresourceMap[imgpair.image].end()) {
37 pCB->imageLayoutMap[imgpair].layout = layout;
38 } else {
39 assert(imgpair.hasSubresource);
40 IMAGE_CMD_BUF_LAYOUT_NODE node;
41 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
42 node.initialLayout = layout;
43 }
44 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
45 }
46}
47template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070048void SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070049 ImageSubresourcePair imgpair = {image, true, range};
50 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
51 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
52 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
53 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
54}
55
56template <class OBJECT, class LAYOUT>
Tobin Ehlis58c884f2017-02-08 12:15:27 -070057void SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070058 VkImageAspectFlags aspectMask) {
59 if (imgpair.subresource.aspectMask & aspectMask) {
60 imgpair.subresource.aspectMask = aspectMask;
61 SetLayout(device_data, pObject, imgpair, layout);
62 }
63}
64
Tony Barbourdf013b92017-01-25 12:53:48 -070065// Set the layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -070066void SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
67 VkImageLayout layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -070068 imageLayoutMap[imgpair].layout = layout;
69}
70
Tobin Ehlis58c884f2017-02-08 12:15:27 -070071bool FindLayoutVerifyNode(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070072 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
73 const debug_report_data *report_data = core_validation::GetReportData(device_data);
74
75 if (!(imgpair.subresource.aspectMask & aspectMask)) {
76 return false;
77 }
78 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
79 imgpair.subresource.aspectMask = aspectMask;
80 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
81 if (imgsubIt == pCB->imageLayoutMap.end()) {
82 return false;
83 }
84 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
85 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
86 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
87 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
88 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.layout),
89 string_VkImageLayout(imgsubIt->second.layout));
90 }
91 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
92 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
93 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
94 "Cannot query for VkImage 0x%" PRIx64
95 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
96 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(node.initialLayout),
97 string_VkImageLayout(imgsubIt->second.initialLayout));
98 }
99 node = imgsubIt->second;
100 return true;
101}
102
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700103bool FindLayoutVerifyLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700104 const VkImageAspectFlags aspectMask) {
105 if (!(imgpair.subresource.aspectMask & aspectMask)) {
106 return false;
107 }
108 const debug_report_data *report_data = core_validation::GetReportData(device_data);
109 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
110 imgpair.subresource.aspectMask = aspectMask;
111 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
112 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) {
113 return false;
114 }
115 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
116 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
117 reinterpret_cast<uint64_t &>(imgpair.image), __LINE__, DRAWSTATE_INVALID_LAYOUT, "DS",
118 "Cannot query for VkImage 0x%" PRIx64 " layout when combined aspect mask %d has multiple layout types: %s and %s",
119 reinterpret_cast<uint64_t &>(imgpair.image), oldAspectMask, string_VkImageLayout(layout),
120 string_VkImageLayout(imgsubIt->second.layout));
121 }
122 layout = imgsubIt->second.layout;
123 return true;
124}
125
126// Find layout(s) on the command buffer level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700127bool FindCmdBufLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700128 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
129 ImageSubresourcePair imgpair = {image, true, range};
130 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
131 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
132 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
133 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
134 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
135 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
136 imgpair = {image, false, VkImageSubresource()};
137 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
138 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
139 // TODO: This is ostensibly a find function but it changes state here
140 node = imgsubIt->second;
141 }
142 return true;
143}
144
145// Find layout(s) on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700146bool FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700147 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
148 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
149 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
150 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
151 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
152 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
153 imgpair = {imgpair.image, false, VkImageSubresource()};
154 auto imgsubIt = (*core_validation::GetImageLayoutMap(device_data)).find(imgpair);
155 if (imgsubIt == (*core_validation::GetImageLayoutMap(device_data)).end()) return false;
156 layout = imgsubIt->second.layout;
157 }
158 return true;
159}
160
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700161bool FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700162 auto sub_data = (*core_validation::GetImageSubresourceMap(device_data)).find(image);
163 if (sub_data == (*core_validation::GetImageSubresourceMap(device_data)).end()) return false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700164 auto image_state = GetImageState(device_data, image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700165 if (!image_state) return false;
166 bool ignoreGlobal = false;
167 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
168 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
169 ignoreGlobal = true;
170 }
171 for (auto imgsubpair : sub_data->second) {
172 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
173 auto img_data = (*core_validation::GetImageLayoutMap(device_data)).find(imgsubpair);
174 if (img_data != (*core_validation::GetImageLayoutMap(device_data)).end()) {
175 layouts.push_back(img_data->second.layout);
176 }
177 }
178 return true;
179}
Tony Barboure0c5cc92017-02-08 13:53:39 -0700180bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
181 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700182 if (!(imgpair.subresource.aspectMask & aspectMask)) {
183 return false;
184 }
185 imgpair.subresource.aspectMask = aspectMask;
186 auto imgsubIt = imageLayoutMap.find(imgpair);
187 if (imgsubIt == imageLayoutMap.end()) {
188 return false;
189 }
190 layout = imgsubIt->second.layout;
191 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700192}
Tony Barbourdf013b92017-01-25 12:53:48 -0700193
194// find layout in supplied map
Tony Barboure0c5cc92017-02-08 13:53:39 -0700195bool FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap, ImageSubresourcePair imgpair,
196 VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700197 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
198 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
199 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
200 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
201 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
202 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
203 imgpair = {imgpair.image, false, VkImageSubresource()};
204 auto imgsubIt = imageLayoutMap.find(imgpair);
205 if (imgsubIt == imageLayoutMap.end()) return false;
206 layout = imgsubIt->second.layout;
207 }
208 return true;
209}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210
211// Set the layout on the global level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700212void SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700213 VkImage &image = imgpair.image;
214 (*core_validation::GetImageLayoutMap(device_data))[imgpair].layout = layout;
215 auto &image_subresources = (*core_validation::GetImageSubresourceMap(device_data))[image];
216 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
217 if (subresource == image_subresources.end()) {
218 image_subresources.push_back(imgpair);
219 }
220}
221
222// Set the layout on the cmdbuf level
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700223void SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700224 pCB->imageLayoutMap[imgpair] = node;
225 auto subresource =
226 std::find(pCB->imageSubresourceMap[imgpair.image].begin(), pCB->imageSubresourceMap[imgpair.image].end(), imgpair);
227 if (subresource == pCB->imageSubresourceMap[imgpair.image].end()) {
228 pCB->imageSubresourceMap[imgpair.image].push_back(imgpair);
229 }
230}
231
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700232void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, VkImageView imageView, const VkImageLayout &layout) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700233 auto view_state = GetImageViewState(device_data, imageView);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700234 assert(view_state);
235 auto image = view_state->create_info.image;
236 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
237 // TODO: Do not iterate over every possibility - consolidate where possible
238 for (uint32_t j = 0; j < subRange.levelCount; j++) {
239 uint32_t level = subRange.baseMipLevel + j;
240 for (uint32_t k = 0; k < subRange.layerCount; k++) {
241 uint32_t layer = subRange.baseArrayLayer + k;
242 VkImageSubresource sub = {subRange.aspectMask, level, layer};
243 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
244 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
245 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
246 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
247 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
248 }
249 }
250 SetLayout(device_data, pCB, image, sub, layout);
251 }
252 }
253}
254
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700255bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700256 const VkRenderPassBeginInfo *pRenderPassBegin,
257 const FRAMEBUFFER_STATE *framebuffer_state) {
258 bool skip_call = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700259 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700260 auto const &framebufferInfo = framebuffer_state->createInfo;
261 const auto report_data = core_validation::GetReportData(device_data);
262 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
263 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
264 DRAWSTATE_INVALID_RENDERPASS, "DS",
265 "You cannot start a render pass using a framebuffer "
266 "with a different number of attachments.");
267 }
268 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
269 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700270 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700271 assert(view_state);
272 const VkImage &image = view_state->create_info.image;
273 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
274 IMAGE_CMD_BUF_LAYOUT_NODE newNode = {pRenderPassInfo->pAttachments[i].initialLayout,
275 pRenderPassInfo->pAttachments[i].initialLayout};
276 // TODO: Do not iterate over every possibility - consolidate where possible
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700277 // TODO: Consolidate this with SetImageViewLayout() function above
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700278 for (uint32_t j = 0; j < subRange.levelCount; j++) {
279 uint32_t level = subRange.baseMipLevel + j;
280 for (uint32_t k = 0; k < subRange.layerCount; k++) {
281 uint32_t layer = subRange.baseArrayLayer + k;
282 VkImageSubresource sub = {subRange.aspectMask, level, layer};
283 IMAGE_CMD_BUF_LAYOUT_NODE node;
284 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700285 // If ImageView was created with depth or stencil, transition both aspects if it's a DS image
286 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
287 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
288 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
289 }
290 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700291 SetLayout(device_data, pCB, image, sub, newNode);
292 continue;
293 }
294 if (newNode.layout != VK_IMAGE_LAYOUT_UNDEFINED && newNode.layout != node.layout) {
295 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
296 DRAWSTATE_INVALID_RENDERPASS, "DS",
297 "You cannot start a render pass using attachment %u "
298 "where the render pass initial layout is %s and the previous "
299 "known layout of the attachment is %s. The layouts must match, or "
300 "the render pass initial layout for the attachment must be "
301 "VK_IMAGE_LAYOUT_UNDEFINED",
302 i, string_VkImageLayout(newNode.layout), string_VkImageLayout(node.layout));
303 }
304 }
305 }
306 }
307 return skip_call;
308}
309
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700310void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700311 VkAttachmentReference ref) {
312 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
313 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
314 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
315 }
316}
317
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700318void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
319 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700320 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700321 if (!renderPass) return;
322
323 if (framebuffer_state) {
324 auto const &subpass = renderPass->createInfo.pSubpasses[subpass_index];
325 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
326 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
327 }
328 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
329 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
330 }
331 if (subpass.pDepthStencilAttachment) {
332 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
333 }
334 }
335}
336
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700337bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
338 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700339 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
340 return false;
341 }
342 VkImageSubresource sub = {aspect, level, layer};
343 IMAGE_CMD_BUF_LAYOUT_NODE node;
344 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700345 return false;
346 }
347 bool skip = false;
348 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
349 // TODO: Set memory invalid which is in mem_tracker currently
350 } else if (node.layout != mem_barrier->oldLayout) {
351 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0,
352 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
353 "You cannot transition the layout of aspect %d from %s when current layout is %s.", aspect,
354 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
355 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700356 return skip;
357}
358
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700359void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
360 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
361 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
362 return;
363 }
364 VkImageSubresource sub = {aspect, level, layer};
365 IMAGE_CMD_BUF_LAYOUT_NODE node;
366 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
367 SetLayout(device_data, pCB, mem_barrier->image, sub,
368 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
369 return;
370 }
371 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
372 // TODO: Set memory invalid
373 }
374 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
375}
376
377bool ValidateImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
378 const VkImageMemoryBarrier *pImgMemBarriers) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700379 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700380 bool skip = false;
381 uint32_t levelCount = 0;
382 uint32_t layerCount = 0;
383
384 for (uint32_t i = 0; i < memBarrierCount; ++i) {
385 auto mem_barrier = &pImgMemBarriers[i];
386 if (!mem_barrier) continue;
387 // TODO: Do not iterate over every possibility - consolidate where possible
388 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700389 GetImageState(device_data, mem_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700390
391 for (uint32_t j = 0; j < levelCount; j++) {
392 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
393 for (uint32_t k = 0; k < layerCount; k++) {
394 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700395 skip |= ValidateImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
396 skip |= ValidateImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
397 skip |= ValidateImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
398 skip |= ValidateImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700399 }
400 }
401 }
402 return skip;
403}
404
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700405void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
406 const VkImageMemoryBarrier *pImgMemBarriers) {
407 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
408 uint32_t levelCount = 0;
409 uint32_t layerCount = 0;
410
411 for (uint32_t i = 0; i < memBarrierCount; ++i) {
412 auto mem_barrier = &pImgMemBarriers[i];
413 if (!mem_barrier) continue;
414 // TODO: Do not iterate over every possibility - consolidate where possible
415 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
416 GetImageState(device_data, mem_barrier->image));
417
418 for (uint32_t j = 0; j < levelCount; j++) {
419 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
420 for (uint32_t k = 0; k < layerCount; k++) {
421 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
422 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
423 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
424 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
425 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
426 }
427 }
428 }
429}
430
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700431bool VerifySourceImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage srcImage, VkImageSubresourceLayers subLayers,
432 VkImageLayout srcImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700433 const auto report_data = core_validation::GetReportData(device_data);
434 bool skip_call = false;
435
436 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
437 uint32_t layer = i + subLayers.baseArrayLayer;
438 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
439 IMAGE_CMD_BUF_LAYOUT_NODE node;
440 if (!FindCmdBufLayout(device_data, cb_node, srcImage, sub, node)) {
441 SetLayout(device_data, cb_node, srcImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(srcImageLayout, srcImageLayout));
442 continue;
443 }
444 if (node.layout != srcImageLayout) {
445 // TODO: Improve log message in the next pass
446 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
447 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
448 "Cannot copy from an image whose source layout is %s "
449 "and doesn't match the current layout %s.",
450 string_VkImageLayout(srcImageLayout), string_VkImageLayout(node.layout));
451 }
452 }
453 if (srcImageLayout != VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) {
454 if (srcImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
455 // 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 -0700456 auto image_state = GetImageState(device_data, srcImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700457 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
458 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
459 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
460 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
461 "Layout for input image should be TRANSFER_SRC_OPTIMAL instead of GENERAL.");
462 }
463 } else {
464 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
465 "DS", "Layout for input image is %s but can only be TRANSFER_SRC_OPTIMAL or GENERAL. %s",
466 string_VkImageLayout(srcImageLayout), validation_error_map[msgCode]);
467 }
468 }
469 return skip_call;
470}
471
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700472bool VerifyDestImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage destImage, VkImageSubresourceLayers subLayers,
473 VkImageLayout destImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700474 const auto report_data = core_validation::GetReportData(device_data);
475 bool skip_call = false;
476
477 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
478 uint32_t layer = i + subLayers.baseArrayLayer;
479 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
480 IMAGE_CMD_BUF_LAYOUT_NODE node;
481 if (!FindCmdBufLayout(device_data, cb_node, destImage, sub, node)) {
482 SetLayout(device_data, cb_node, destImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(destImageLayout, destImageLayout));
483 continue;
484 }
485 if (node.layout != destImageLayout) {
486 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
487 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
488 "Cannot copy from an image whose dest layout is %s and "
489 "doesn't match the current layout %s.",
490 string_VkImageLayout(destImageLayout), string_VkImageLayout(node.layout));
491 }
492 }
493 if (destImageLayout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
494 if (destImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700495 auto image_state = GetImageState(device_data, destImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700496 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
497 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
498 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
499 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
500 "Layout for output image should be TRANSFER_DST_OPTIMAL instead of GENERAL.");
501 }
502 } else {
503 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
504 "DS", "Layout for output image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s",
505 string_VkImageLayout(destImageLayout), validation_error_map[msgCode]);
506 }
507 }
508 return skip_call;
509}
510
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700511void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
512 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700513 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700514 if (!renderPass) return;
515
516 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
517 if (framebuffer_state) {
518 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
519 auto image_view = framebuffer_state->createInfo.pAttachments[i];
520 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
521 }
522 }
523}
524
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700525bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700526 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
527 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700528 const debug_report_data *report_data = core_validation::GetReportData(device_data);
529
530 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700531 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700532
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700533 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700534 std::stringstream ss;
535 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
536 skip_call |=
537 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
538 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
539 }
540
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700541 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700542 std::stringstream ss;
543 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
544 skip_call |=
545 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
546 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
547 }
548
549 // Validate that format supports usage as color attachment
550 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
551 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700552 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700553 std::stringstream ss;
554 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
555 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
556 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
557 __LINE__, VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(),
558 validation_error_map[VALIDATION_ERROR_02158]);
559 }
560 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700561 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700562 std::stringstream ss;
563 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
564 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
565 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
566 __LINE__, VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(),
567 validation_error_map[VALIDATION_ERROR_02153]);
568 }
569 }
570 // Validate that format supports usage as depth/stencil attachment
571 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
572 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700573 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700574 std::stringstream ss;
575 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
576 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
577 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
578 __LINE__, VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(),
579 validation_error_map[VALIDATION_ERROR_02159]);
580 }
581 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700582 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700583 std::stringstream ss;
584 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
585 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
586 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
587 __LINE__, VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(),
588 validation_error_map[VALIDATION_ERROR_02154]);
589 }
590 }
591 } else {
592 skip_call |=
593 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
594 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
595 validation_error_map[VALIDATION_ERROR_00715]);
596 }
597
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700598 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
599 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700600
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700601 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700602 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
603
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700604 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
605 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
606 VALIDATION_ERROR_00716, "Image",
607 "CreateImage extent is 0 for at least one required dimension for image: "
608 "Width = %d Height = %d Depth = %d. %s",
609 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
610 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700611 }
612
613 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
614 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700615 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
616 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
617 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700618 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
619 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
620 "CreateImage extents exceed allowable limits for format: "
621 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
622 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700623 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
624 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700625 }
626
627 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
628 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
629 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
630 (uint64_t)imageGranularity) &
631 ~(uint64_t)imageGranularity;
632
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700633 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700634 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
635 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
636 "CreateImage resource size exceeds allowable maximum "
637 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700638 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700639 }
640
641 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700642 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700643 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
644 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
645 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700646 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700647 }
648
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700649 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700650 skip_call |= log_msg(
651 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
652 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700653 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700654 }
655
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700656 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700657 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
658 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700659 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700660 validation_error_map[VALIDATION_ERROR_02138]);
661 }
662
663 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
664 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
665 VALIDATION_ERROR_00731, "Image",
666 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
667 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
668 validation_error_map[VALIDATION_ERROR_00731]);
669 }
670
671 return skip_call;
672}
673
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700674void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700675 IMAGE_LAYOUT_NODE image_state;
676 image_state.layout = pCreateInfo->initialLayout;
677 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700678 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 -0700679 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700680 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
681 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700682}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700683
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700684bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700685 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700686 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700687 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
688 if (disabled->destroy_image) return false;
689 bool skip = false;
690 if (*image_state) {
691 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
692 }
693 return skip;
694}
695
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700696void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700697 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
698 // Clean up memory mapping, bindings and range references for image
699 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700700 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700701 if (mem_info) {
702 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
703 }
704 }
705 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
706 // Remove image from imageMap
707 core_validation::GetImageMap(device_data)->erase(image);
708 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
709 core_validation::GetImageSubresourceMap(device_data);
710
711 const auto &sub_entry = imageSubresourceMap->find(image);
712 if (sub_entry != imageSubresourceMap->end()) {
713 for (const auto &pair : sub_entry->second) {
714 core_validation::GetImageLayoutMap(device_data)->erase(pair);
715 }
716 imageSubresourceMap->erase(sub_entry);
717 }
718}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700719
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700720bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700721 bool skip = false;
722 const debug_report_data *report_data = core_validation::GetReportData(device_data);
723
724 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
725 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
726 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
727 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
728 }
729
730 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
731 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
732 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
733 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
734 validation_error_map[VALIDATION_ERROR_01088]);
735 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
736 char const str[] = "vkCmdClearColorImage called with compressed image.";
737 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
738 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
739 validation_error_map[VALIDATION_ERROR_01088]);
740 }
741
742 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
743 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
744 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
745 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
746 validation_error_map[VALIDATION_ERROR_01084]);
747 }
748 return skip;
749}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700750
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700751void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700752 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
753 // internal state to the actual values.
754 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
755 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
756 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700757
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700758 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
759 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700760 }
761}
762
763// 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 -0700764void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
765 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700766 *levels = range.levelCount;
767 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700768 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
769 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
770 }
771 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
772 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700773 }
774}
775
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700776bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700777 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
778 bool skip = false;
779 const debug_report_data *report_data = core_validation::GetReportData(device_data);
780
781 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700782 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700783
784 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
785 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700786 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
787 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
788 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
789 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
790 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
791 }
792 } else {
793 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
794 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
795 error_code = VALIDATION_ERROR_01101;
796 } else {
797 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
798 }
799 skip |=
800 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, error_code, "DS",
801 "%s: Layout for cleared image is %s but can only be "
802 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
803 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
804 }
805 }
806
807 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
808 uint32_t level = level_index + resolved_range.baseMipLevel;
809 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
810 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
811 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
812 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700813 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700814 if (node.layout != dest_image_layout) {
815 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
816 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
817 error_code = VALIDATION_ERROR_01100;
818 } else {
819 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
820 }
821 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
822 __LINE__, error_code, "DS",
823 "%s: Cannot clear an image whose layout is %s and "
824 "doesn't match the current layout %s. %s",
825 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
826 validation_error_map[error_code]);
827 }
828 }
829 }
830 }
831
832 return skip;
833}
834
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700835void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
836 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700837 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700838 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700839
840 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
841 uint32_t level = level_index + resolved_range.baseMipLevel;
842 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
843 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
844 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
845 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700846 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
847 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 -0700848 }
849 }
850 }
851}
852
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700853bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700854 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
855 bool skip = false;
856 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700857 auto cb_node = GetCBNode(dev_data, commandBuffer);
858 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700859 if (cb_node && image_state) {
860 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
861 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
862 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
863 for (uint32_t i = 0; i < rangeCount; ++i) {
864 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700865 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700866 }
867 }
868 return skip;
869}
870
871// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700872void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
873 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700874 auto cb_node = GetCBNode(dev_data, commandBuffer);
875 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700876 if (cb_node && image_state) {
877 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
878 std::function<bool()> function = [=]() {
879 SetImageMemoryValid(dev_data, image_state, true);
880 return false;
881 };
882 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700883 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700884 for (uint32_t i = 0; i < rangeCount; ++i) {
885 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
886 }
887 }
888}
889
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700890bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
891 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700892 const VkImageSubresourceRange *pRanges) {
893 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700894 const debug_report_data *report_data = core_validation::GetReportData(device_data);
895
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700896 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700897 auto cb_node = GetCBNode(device_data, commandBuffer);
898 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700899 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700900 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
901 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
902 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700903 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700904 skip |=
905 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700906 // Image aspect must be depth or stencil or both
907 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
908 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
909 char const str[] =
910 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
911 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
912 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
913 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
914 }
915 }
916 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
917 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
918 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
919 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
920 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700921 }
922 }
923 return skip;
924}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -0700925
926// Returns true if [x, xoffset] and [y, yoffset] overlap
927static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
928 bool result = false;
929 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
930 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
931
932 if (intersection_max > intersection_min) {
933 result = true;
934 }
935 return result;
936}
937
938// Returns true if two VkImageCopy structures overlap
939static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
940 bool result = false;
941 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
942 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
943 dst->dstSubresource.layerCount))) {
944 result = true;
945 switch (type) {
946 case VK_IMAGE_TYPE_3D:
947 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
948 // Intentionally fall through to 2D case
949 case VK_IMAGE_TYPE_2D:
950 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
951 // Intentionally fall through to 1D case
952 case VK_IMAGE_TYPE_1D:
953 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
954 break;
955 default:
956 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
957 assert(false);
958 }
959 }
960 return result;
961}
962
963// Returns true if offset and extent exceed image extents
Dave Houlton9dae7ec2017-03-01 16:23:25 -0700964static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -0700965 bool result = false;
966 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -0700967 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
968 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
969 result = true;
970 }
971 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
972 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
973 result = true;
974 }
975 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
976 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
977 result = true;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -0700978 }
979 return result;
980}
981
Mark Lobodzinskiab9be282017-02-09 12:01:27 -0700982// Test if two VkExtent3D structs are equivalent
983static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
984 bool result = true;
985 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
986 (extent->depth != other_extent->depth)) {
987 result = false;
988 }
989 return result;
990}
991
992// Returns the image extent of a specific subresource.
993static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
994 const uint32_t mip = subresource->mipLevel;
995 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -0700996 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
997 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
998 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
999 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001000 return extent;
1001}
1002
1003// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001004static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001005 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1006}
1007
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001008// Test if the extent argument has any dimensions set to 0.
1009static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1010 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1011}
1012
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001013// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1014static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1015 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1016 VkExtent3D granularity = {0, 0, 0};
1017 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1018 if (pPool) {
1019 granularity =
1020 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
1021 if (vk_format_is_compressed(img->createInfo.format)) {
Mark Lobodzinski13086442017-02-24 08:53:14 -07001022 auto block_size = vk_format_compressed_texel_block_extents(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001023 granularity.width *= block_size.width;
1024 granularity.height *= block_size.height;
1025 }
1026 }
1027 return granularity;
1028}
1029
1030// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1031static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1032 bool valid = true;
1033 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
1034 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
1035 valid = false;
1036 }
1037 return valid;
1038}
1039
1040// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1041static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1042 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1043 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1044 bool skip = false;
1045 VkExtent3D offset_extent = {};
1046 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1047 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1048 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001049 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001050 // 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 -07001051 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1053 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1054 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1055 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1056 function, i, member, offset->x, offset->y, offset->z);
1057 }
1058 } else {
1059 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1060 // integer multiples of the image transfer granularity.
1061 if (IsExtentAligned(&offset_extent, granularity) == false) {
1062 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1063 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1064 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1065 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1066 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1067 granularity->depth);
1068 }
1069 }
1070 return skip;
1071}
1072
1073// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1074static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1075 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1076 const uint32_t i, const char *function, const char *member) {
1077 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1078 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001079 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001080 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1081 // subresource extent.
1082 if (IsExtentEqual(extent, subresource_extent) == false) {
1083 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1084 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1085 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1086 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1087 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1088 subresource_extent->height, subresource_extent->depth);
1089 }
1090 } else {
1091 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1092 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1093 // subresource extent dimensions.
1094 VkExtent3D offset_extent_sum = {};
1095 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1096 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1097 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1098 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1099 skip |=
1100 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1101 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1102 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1103 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1104 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1105 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1106 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1107 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1108 }
1109 }
1110 return skip;
1111}
1112
1113// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1114static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1115 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1116 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1117
1118 bool skip = false;
1119 if (vk_safe_modulo(value, granularity) != 0) {
1120 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1121 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1122 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1123 "transfer granularity width (%d).",
1124 function, i, member, value, granularity);
1125 }
1126 return skip;
1127}
1128
1129// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1130static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1131 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1132 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1133 bool skip = false;
1134 if (vk_safe_modulo(value, granularity) != 0) {
1135 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1136 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1137 "%s: pRegion[%d].%s (%" PRIdLEAST64
1138 ") must be an even integer multiple of this command buffer's queue family image transfer "
1139 "granularity width (%d).",
1140 function, i, member, value, granularity);
1141 }
1142 return skip;
1143}
1144
1145// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1146bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1147 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1148 const uint32_t i, const char *function) {
1149 bool skip = false;
1150 if (vk_format_is_compressed(img->createInfo.format) == true) {
1151 // TODO: Add granularity checking for compressed formats
1152
1153 // bufferRowLength must be a multiple of the compressed texel block width
1154 // bufferImageHeight must be a multiple of the compressed texel block height
1155 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1156 // bufferOffset must be a multiple of the compressed texel block size in bytes
1157 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1158 // must equal the image subresource width
1159 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1160 // must equal the image subresource height
1161 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1162 // must equal the image subresource depth
1163 } else {
1164 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1165 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1166 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1167 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1168 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1169 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1170 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1171 i, function, "imageExtent");
1172 }
1173 return skip;
1174}
1175
1176// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1177bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1178 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1179 const char *function) {
1180 bool skip = false;
1181 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1182 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1183 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1184 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1185 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1186 function, "extent");
1187 return skip;
1188}
1189
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001190bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001191 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1192 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001193 bool skip = false;
1194 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1195 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1196
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001197 for (uint32_t i = 0; i < region_count; i++) {
1198 if (regions[i].srcSubresource.layerCount == 0) {
1199 std::stringstream ss;
1200 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1201 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1202 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1203 ss.str().c_str());
1204 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001205
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001206 if (regions[i].dstSubresource.layerCount == 0) {
1207 std::stringstream ss;
1208 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1209 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1210 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1211 ss.str().c_str());
1212 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001213
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001214 // For each region the layerCount member of srcSubresource and dstSubresource must match
1215 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1216 std::stringstream ss;
1217 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1218 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1219 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1220 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1221 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001222
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001223 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1224 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1225 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1226 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1227 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1228 validation_error_map[VALIDATION_ERROR_01197]);
1229 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001230
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001231 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1232 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1233 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1234 std::stringstream ss;
1235 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1236 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1237 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1238 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1239 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001240
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001241 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1242 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1243 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1244 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1245 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1246 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1247 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1248 validation_error_map[VALIDATION_ERROR_01221]);
1249 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001250
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001251 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1252 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1253 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1254 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1255 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1256 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1257 std::stringstream ss;
1258 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1259 << "] baseArrayLayer was not zero or layerCount was not 1.";
1260 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1261 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1262 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1263 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001264
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001265 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1266 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1267 std::stringstream ss;
1268 ss << "vkCmdCopyImage: pRegions[" << i
1269 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1270 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1271 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1272 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1273 }
1274 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1275 std::stringstream ss;
1276 ss << "vkCmdCopyImage: pRegions[" << i
1277 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1278 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1279 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1280 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1281 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001282
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001283 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1284 // image was created
1285 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1286 src_image_state->createInfo.arrayLayers) {
1287 std::stringstream ss;
1288 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1289 << "] baseArrayLayer + layerCount is "
1290 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1291 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1292 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1293 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1294 }
1295 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1296 dst_image_state->createInfo.arrayLayers) {
1297 std::stringstream ss;
1298 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1299 << "] baseArrayLayer + layerCount is "
1300 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1301 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1302 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1303 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1304 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001305
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001306 // 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 -07001307 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &(src_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001308 std::stringstream ss;
1309 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1310 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1311 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1312 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1313 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001314
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001315 // 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 -07001316 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &(dst_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001317 std::stringstream ss;
1318 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1319 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1320 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1321 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1322 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001323
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001324 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1325 // must not overlap in memory
1326 if (src_image_state->image == dst_image_state->image) {
1327 for (uint32_t j = 0; j < region_count; j++) {
1328 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1329 std::stringstream ss;
1330 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1331 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1332 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1333 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001334 }
1335 }
1336 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001337 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001338
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001339 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1340 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1341 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1342 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1343 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1344 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1345 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1346 skip |=
1347 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1348 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1349 }
1350 } else {
1351 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1352 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1353 if (srcSize != destSize) {
1354 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1356 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1357 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001358 }
1359 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001360
1361 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1362 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1363 // Validate that SRC & DST images have correct usage flags set
1364 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1365 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1366 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1367 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
1368 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1369 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1370 for (uint32_t i = 0; i < region_count; ++i) {
1371 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, regions[i].srcSubresource, src_image_layout,
1372 VALIDATION_ERROR_01180);
1373 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, regions[i].dstSubresource, dst_image_layout,
1374 VALIDATION_ERROR_01183);
1375 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1376 "vkCmdCopyImage()");
1377 }
1378
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001379 return skip;
1380}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001381
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001382void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1383 IMAGE_STATE *dst_image_state) {
1384 // Update bindings between images and cmd buffer
1385 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1386 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1387 std::function<bool()> function = [=]() {
1388 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()");
1389 };
1390 cb_node->validate_functions.push_back(function);
1391 function = [=]() {
1392 SetImageMemoryValid(device_data, dst_image_state, true);
1393 return false;
1394 };
1395 cb_node->validate_functions.push_back(function);
1396 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1397}
1398
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001399// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1400// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1401// to that same cmd buffer by separate thread are not changing state from underneath us
1402// Track the last cmd buffer touched by this thread
1403static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1404 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1405 if (pCB->drawCount[i]) return true;
1406 }
1407 return false;
1408}
1409
1410// Returns true if sub_rect is entirely contained within rect
1411static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1412 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1413 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1414 return false;
1415 return true;
1416}
1417
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001418bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1419 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001420 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001421 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1422
1423 bool skip = false;
1424 if (cb_node) {
1425 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001426 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001427 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1428 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1429 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1430 // 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 -07001431 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
1432 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001433 skip |=
1434 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1435 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1436 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1437 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1438 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001439 }
1440 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1441 }
1442
1443 // Validate that attachment is in reference list of active subpass
1444 if (cb_node->activeRenderPass) {
1445 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1446 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001447 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001448
1449 for (uint32_t i = 0; i < attachmentCount; i++) {
1450 auto clear_desc = &pAttachments[i];
1451 VkImageView image_view = VK_NULL_HANDLE;
1452
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001453 if (0 == clear_desc->aspectMask) {
1454 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1455 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
1456 validation_error_map[VALIDATION_ERROR_01128]);
1457 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1458 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1459 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
1460 validation_error_map[VALIDATION_ERROR_01126]);
1461 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001462 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001463 skip |=
1464 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1465 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01114, "DS",
1466 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1467 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001468 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1469 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001470 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1471 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1472 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1473 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001474 } else {
1475 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001476 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001477 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001478 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1479 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1480 char const str[] =
1481 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1482 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1483 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
1484 validation_error_map[VALIDATION_ERROR_01125]);
1485 }
1486 } else { // Must be depth and/or stencil
1487 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1488 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1489 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1490 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1491 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
1492 validation_error_map[VALIDATION_ERROR_01127]);
1493 }
1494 if (!subpass_desc->pDepthStencilAttachment ||
1495 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1496 skip |= log_msg(
1497 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1498 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1499 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001500 } else {
1501 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1502 }
1503 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001504 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001505 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001506 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001507 // The rectangular region specified by a given element of pRects must be contained within the render area of
1508 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001509 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
1510 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
1511 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1513 __LINE__, VALIDATION_ERROR_01115, "DS",
1514 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1515 "the current render pass instance. %s",
1516 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001517 }
1518 // The layers specified by a given element of pRects must be contained within every attachment that
1519 // pAttachments refers to
1520 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1521 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1522 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1523 skip |=
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001524 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1525 __LINE__, VALIDATION_ERROR_01116, "DS",
1526 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1527 "pAttachment[%d]. %s",
1528 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001529 }
1530 }
1531 }
1532 }
1533 }
1534 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001535}
1536
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001537bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001538 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001539 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001540 bool skip = false;
1541 if (cb_node && src_image_state && dst_image_state) {
1542 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1543 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
1544 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1545 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001546
1547 // For each region, the number of layers in the image subresource should not be zero
1548 // For each region, src and dest image aspect must be color only
1549 for (uint32_t i = 0; i < regionCount; i++) {
1550 if (pRegions[i].srcSubresource.layerCount == 0) {
1551 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001552 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 -07001553 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1554 "IMAGE", str);
1555 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001556 if (pRegions[i].dstSubresource.layerCount == 0) {
1557 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001558 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 -07001559 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1560 "IMAGE", str);
1561 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001562 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1563 skip |= log_msg(
1564 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1565 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1566 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1567 validation_error_map[VALIDATION_ERROR_01339]);
1568 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001569 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1570 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1571 char const str[] =
1572 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1573 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1574 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1575 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1576 }
1577 }
1578
1579 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1580 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001581 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 -07001582 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1583 "IMAGE", str);
1584 }
1585 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1586 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001587 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 -07001588 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1589 str);
1590 }
1591 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1592 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1593 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1594 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1595 str, validation_error_map[VALIDATION_ERROR_01320]);
1596 }
1597 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1598 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1599 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1600 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1601 str, validation_error_map[VALIDATION_ERROR_01321]);
1602 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001603 } else {
1604 assert(0);
1605 }
1606 return skip;
1607}
1608
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001609void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1610 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001611 // Update bindings between images and cmd buffer
1612 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1613 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1614
1615 std::function<bool()> function = [=]() {
1616 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1617 };
1618 cb_node->validate_functions.push_back(function);
1619 function = [=]() {
1620 SetImageMemoryValid(device_data, dst_image_state, true);
1621 return false;
1622 };
1623 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001624 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001625}
1626
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001627bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001628 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1629 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1630
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001631 bool skip = false;
1632 if (cb_node && src_image_state && dst_image_state) {
1633 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001634 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001635 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001636 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001637 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1638 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1639 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001640 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001641 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001642 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001643 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1644 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001645
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001646 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001647
1648 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001649 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1650 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1651 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1652 std::stringstream ss;
1653 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1654 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1655 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1656 "%s", ss.str().c_str());
1657 }
1658 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1659 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1660 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1661 std::stringstream ss;
1662 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1663 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1664 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1665 "%s", ss.str().c_str());
1666 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001667 if (pRegions[i].srcSubresource.layerCount == 0) {
1668 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1669 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1670 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1671 "IMAGE", str);
1672 }
1673 if (pRegions[i].dstSubresource.layerCount == 0) {
1674 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1675 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1676 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1677 "IMAGE", str);
1678 }
1679
1680 // Check that src/dst layercounts match
1681 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1682 skip |=
1683 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1684 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1685 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1686 i, validation_error_map[VALIDATION_ERROR_01304]);
1687 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001688
1689 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1691 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1692 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1693 validation_error_map[VALIDATION_ERROR_01303]);
1694 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001695 }
1696
1697 VkFormat src_format = src_image_state->createInfo.format;
1698 VkFormat dst_format = dst_image_state->createInfo.format;
1699
1700 // Validate consistency for unsigned formats
1701 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1702 std::stringstream ss;
1703 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1704 << "the other one must also have unsigned integer format. "
1705 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1706 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1707 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1708 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1709 }
1710
1711 // Validate consistency for signed formats
1712 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1713 std::stringstream ss;
1714 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1715 << "the other one must also have signed integer format. "
1716 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1717 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1718 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1719 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1720 }
1721
1722 // Validate aspect bits and formats for depth/stencil images
1723 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001724
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001725 if (src_format != dst_format) {
1726 std::stringstream ss;
1727 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1728 << "stencil, the other one must have exactly the same format. "
1729 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1730 << string_VkFormat(dst_format);
1731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1732 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1733 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1734 }
1735
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001736 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001737 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001738
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001739 if (vk_format_is_depth_and_stencil(src_format)) {
1740 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1741 std::stringstream ss;
1742 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1743 "VK_IMAGE_ASPECT_DEPTH_BIT "
1744 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1745 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1746 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1747 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1748 }
1749 } else if (vk_format_is_stencil_only(src_format)) {
1750 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1751 std::stringstream ss;
1752 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1753 << "set in both the srcImage and dstImage";
1754 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1755 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1756 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1757 }
1758 } else if (vk_format_is_depth_only(src_format)) {
1759 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1760 std::stringstream ss;
1761 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1762 << "set in both the srcImage and dstImage";
1763 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1764 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1765 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1766 }
1767 }
1768 }
1769 }
1770
1771 // Validate filter
1772 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1773 std::stringstream ss;
1774 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1775 << "then filter must be VK_FILTER_NEAREST.";
1776 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1777 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1778 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1779 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001780 } else {
1781 assert(0);
1782 }
1783 return skip;
1784}
1785
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001786void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1787 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001788 // Update bindings between images and cmd buffer
1789 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1790 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1791
1792 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1793 cb_node->validate_functions.push_back(function);
1794 function = [=]() {
1795 SetImageMemoryValid(device_data, dst_image_state, true);
1796 return false;
1797 };
1798 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001799 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001800}
1801
Tony Barbourdf013b92017-01-25 12:53:48 -07001802// This validates that the initial layout specified in the command buffer for
1803// the IMAGE is the same
1804// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001805bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1806 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001807 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001808 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001809 for (auto cb_image_data : pCB->imageLayoutMap) {
1810 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001811
Jeremy Hayes55b6c292017-02-28 09:44:45 -07001812 if (FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001813 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1814 // TODO: Set memory invalid which is in mem_tracker currently
1815 } else if (imageLayout != cb_image_data.second.initialLayout) {
1816 if (cb_image_data.first.hasSubresource) {
Tony Barboure0c5cc92017-02-08 13:53:39 -07001817 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1818 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT,
1819 "DS", "Cannot submit cmd buffer using image (0x%" PRIx64
1820 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1821 "with layout %s when first use is %s.",
1822 reinterpret_cast<const uint64_t &>(cb_image_data.first.image),
1823 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
1824 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(imageLayout),
1825 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001826 } else {
Tony Barboure0c5cc92017-02-08 13:53:39 -07001827 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1828 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT,
1829 "DS", "Cannot submit cmd buffer using image (0x%" PRIx64
1830 ") with layout %s when "
1831 "first use is %s.",
1832 reinterpret_cast<const uint64_t &>(cb_image_data.first.image),
1833 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001834 }
1835 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001836 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001837 }
1838 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001839 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001840}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001841
Tony Barbourdf013b92017-01-25 12:53:48 -07001842void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1843 for (auto cb_image_data : pCB->imageLayoutMap) {
1844 VkImageLayout imageLayout;
1845 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1846 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1847 }
1848}
1849
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001850// Print readable FlagBits in FlagMask
1851static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1852 std::string result;
1853 std::string separator;
1854
1855 if (accessMask == 0) {
1856 result = "[None]";
1857 } else {
1858 result = "[";
1859 for (auto i = 0; i < 32; i++) {
1860 if (accessMask & (1 << i)) {
1861 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1862 separator = " | ";
1863 }
1864 }
1865 result = result + "]";
1866 }
1867 return result;
1868}
1869
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001870// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1871// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001872// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001873static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
1874 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
1875 const char *type) {
1876 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1877 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001878
1879 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
1880 if (accessMask & ~(required_bit | optional_bits)) {
1881 // TODO: Verify against Valid Use
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001882 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1883 DRAWSTATE_INVALID_BARRIER, "DS",
1884 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1885 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001886 }
1887 } else {
1888 if (!required_bit) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001889 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1890 DRAWSTATE_INVALID_BARRIER, "DS",
1891 "%s AccessMask %d %s must contain at least one of access bits %d "
1892 "%s when layout is %s, unless the app has previously added a "
1893 "barrier for this transition.",
1894 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
1895 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001896 } else {
1897 std::string opt_bits;
1898 if (optional_bits != 0) {
1899 std::stringstream ss;
1900 ss << optional_bits;
1901 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
1902 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001903 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1904 DRAWSTATE_INVALID_BARRIER, "DS",
1905 "%s AccessMask %d %s must have required access bit %d %s %s when "
1906 "layout is %s, unless the app has previously added a barrier for "
1907 "this transition.",
1908 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
1909 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001910 }
1911 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001912 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001913}
1914
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001915bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
1916 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
1917 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001918
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001919 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001920 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001921 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
1922 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
1923 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
1924 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001925 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001926 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
1927 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
1928 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
1929 break;
1930 }
1931 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
1932 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
1933 break;
1934 }
1935 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
1936 skip |= ValidateMaskBits(
1937 device_data, cmdBuffer, accessMask, layout, 0,
1938 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
1939 type);
1940 break;
1941 }
1942 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
1943 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
1944 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
1945 break;
1946 }
1947 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
1948 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
1949 break;
1950 }
1951 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
1952 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
1953 break;
1954 }
1955 case VK_IMAGE_LAYOUT_UNDEFINED: {
1956 if (accessMask != 0) {
1957 // TODO: Verify against Valid Use section spec
1958 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1959 DRAWSTATE_INVALID_BARRIER, "DS",
1960 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
1961 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
1962 }
1963 break;
1964 }
1965 case VK_IMAGE_LAYOUT_GENERAL:
1966 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001967 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001968 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001969}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001970
1971// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001972// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
1973// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001974bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001975 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
1976 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001977 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
1978 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1979 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
1980 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001981 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
1982 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
1983 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
1984 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001985 }
1986 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001987 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001988}
1989
Mark Lobodzinski552e4402017-02-07 17:14:53 -07001990bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
1991 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07001992 bool skip = false;
1993
1994 // Track when we're observing the first use of an attachment
1995 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
1996 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
1997 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
1998 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
1999 auto attach_index = subpass.pColorAttachments[j].attachment;
2000 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2001
2002 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002003 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
2004 // This is ideal.
2005 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002006
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002007 case VK_IMAGE_LAYOUT_GENERAL:
2008 // May not be optimal; TODO: reconsider this warning based on other constraints?
2009 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2010 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2011 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2012 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002013
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002014 default:
2015 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2016 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2017 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2018 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002019 }
2020
2021 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002022 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2023 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002024 }
2025 attach_first_use[attach_index] = false;
2026 }
2027 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2028 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002029 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2030 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2031 // These are ideal.
2032 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002033
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002034 case VK_IMAGE_LAYOUT_GENERAL:
2035 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2036 // doing a bunch of transitions.
2037 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2038 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2039 "GENERAL layout for depth attachment may not give optimal performance.");
2040 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002041
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002042 default:
2043 // No other layouts are acceptable
2044 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2045 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2046 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2047 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2048 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002049 }
2050
2051 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2052 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002053 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2054 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002055 }
2056 attach_first_use[attach_index] = false;
2057 }
2058 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2059 auto attach_index = subpass.pInputAttachments[j].attachment;
2060 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2061
2062 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002063 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2064 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2065 // These are ideal.
2066 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002067
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002068 case VK_IMAGE_LAYOUT_GENERAL:
2069 // May not be optimal. TODO: reconsider this warning based on other constraints.
2070 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2071 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2072 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2073 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002074
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002075 default:
2076 // No other layouts are acceptable
2077 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2078 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2079 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2080 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002081 }
2082
2083 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002084 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2085 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002086 }
2087 attach_first_use[attach_index] = false;
2088 }
2089 }
2090 return skip;
2091}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002092
2093// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002094bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2095 VkDeviceSize offset, VkDeviceSize end_offset) {
2096 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2097 bool skip = false;
2098 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2099 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002100 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2101 for (auto image_handle : mem_info->bound_images) {
2102 auto img_it = mem_info->bound_ranges.find(image_handle);
2103 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002104 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002105 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002106 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002107 for (auto layout : layouts) {
2108 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Michael Lentinec174b932017-02-10 14:57:15 -06002109 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002110 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Michael Lentinec174b932017-02-10 14:57:15 -06002111 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2112 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002113 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002114 }
2115 }
2116 }
2117 }
2118 }
2119 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002120 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002121}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002122
2123// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2124// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002125static 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 -07002126 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2127 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002128 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002129
2130 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002131 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002132 if (strict) {
2133 correct_usage = ((actual & desired) == desired);
2134 } else {
2135 correct_usage = ((actual & desired) != 0);
2136 }
2137 if (!correct_usage) {
2138 if (msgCode == -1) {
2139 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002140 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG,
2141 "MEM", "Invalid usage flag for %s 0x%" PRIxLEAST64
2142 " used by %s. In this case, %s should have %s set during creation.",
2143 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002144 } else {
2145 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002146 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2147 "Invalid usage flag for %s 0x%" PRIxLEAST64
2148 " used by %s. In this case, %s should have %s set during creation. %s",
2149 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002150 }
2151 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002152 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002153}
2154
2155// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2156// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002157bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002158 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002159 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002160 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2161 msgCode, "image", func_name, usage_string);
2162}
2163
2164// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2165// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002166bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002167 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002168 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002169 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2170 msgCode, "buffer", func_name, usage_string);
2171}
2172
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002173bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002174 bool skip = false;
2175 // TODO: Add check for VALIDATION_ERROR_00658
2176 // TODO: Add check for VALIDATION_ERROR_00666
2177 // TODO: Add check for VALIDATION_ERROR_00667
2178 // TODO: Add check for VALIDATION_ERROR_00668
2179 // TODO: Add check for VALIDATION_ERROR_00669
2180 return skip;
2181}
2182
2183void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2184 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2185 GetBufferMap(device_data)
2186 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2187}
2188
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002189bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2190 bool skip = false;
2191 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002192 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2193 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002194 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002195 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2196 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002197 skip |= ValidateBufferUsageFlags(
2198 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 -07002199 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2200 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002201 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002202}
2203
2204void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2205 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2206}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002207
2208// For the given format verify that the aspect masks make sense
2209bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2210 const char *func_name) {
2211 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2212 bool skip = false;
2213 if (vk_format_is_color(format)) {
2214 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2215 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2216 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2217 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2218 validation_error_map[VALIDATION_ERROR_00741]);
2219 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2220 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2221 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2222 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2223 validation_error_map[VALIDATION_ERROR_00741]);
2224 }
2225 } else if (vk_format_is_depth_and_stencil(format)) {
2226 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2227 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2228 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2229 "%s: Depth/stencil image formats must have "
2230 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2231 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2232 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2233 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
2234 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2235 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2236 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2237 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2238 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2239 }
2240 } else if (vk_format_is_depth_only(format)) {
2241 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2243 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2244 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2245 validation_error_map[VALIDATION_ERROR_00741]);
2246 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2247 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2248 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2249 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2250 validation_error_map[VALIDATION_ERROR_00741]);
2251 }
2252 } else if (vk_format_is_stencil_only(format)) {
2253 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2254 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2255 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2256 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2257 validation_error_map[VALIDATION_ERROR_00741]);
2258 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2259 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2260 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2261 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2262 validation_error_map[VALIDATION_ERROR_00741]);
2263 }
2264 }
2265 return skip;
2266}
2267
2268bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2269 const char *func_name) {
2270 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2271 bool skip = false;
2272 if (subresourceRange.levelCount == 0) {
2273 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2274 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2275 validation_error_map[VALIDATION_ERROR_00768]);
2276 }
2277 if (subresourceRange.layerCount == 0) {
2278 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2279 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2280 validation_error_map[VALIDATION_ERROR_00769]);
2281 }
2282 return skip;
2283}
2284
2285bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2286 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2287 bool skip = false;
2288 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2289 if (image_state) {
2290 skip |= ValidateImageUsageFlags(
2291 device_data, image_state,
2292 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2293 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2294 false, -1, "vkCreateImageView()",
2295 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2296 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2297 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2298 // Checks imported from image layer
2299 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2300 std::stringstream ss;
2301 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2302 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2303 skip |=
2304 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2305 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2306 }
2307 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2308 std::stringstream ss;
2309 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2310 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2311 skip |=
2312 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2313 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2314 }
2315 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2316 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2317
2318 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2319 VkFormat image_format = image_state->createInfo.format;
2320 VkFormat view_format = create_info->format;
2321 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2322
2323 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2324 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2325 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2326 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2327 std::stringstream ss;
2328 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2329 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2330 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2331 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
2332 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2333 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2334 validation_error_map[VALIDATION_ERROR_02171]);
2335 }
2336 } else {
2337 // Format MUST be IDENTICAL to the format the image was created with
2338 if (image_format != view_format) {
2339 std::stringstream ss;
2340 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2341 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2342 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
2343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2344 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2345 validation_error_map[VALIDATION_ERROR_02172]);
2346 }
2347 }
2348
2349 // Validate correct image aspect bits for desired formats and format consistency
2350 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2351 }
2352 return skip;
2353}
2354
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002355void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2356 auto image_view_map = GetImageViewMap(device_data);
2357 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2358
2359 auto image_state = GetImageState(device_data, create_info->image);
2360 auto sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
2361 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002362}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002363
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002364bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2365 BUFFER_STATE *dst_buffer_state) {
2366 bool skip = false;
2367 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2368 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2369 // Validate that SRC & DST buffers have correct usage flags set
2370 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2371 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2372 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2373 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2374 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2375 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2376 return skip;
2377}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002378
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002379void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2380 BUFFER_STATE *dst_buffer_state) {
2381 // Update bindings between buffers and cmd buffer
2382 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2383 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2384
2385 std::function<bool()> function = [=]() {
2386 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2387 };
2388 cb_node->validate_functions.push_back(function);
2389 function = [=]() {
2390 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2391 return false;
2392 };
2393 cb_node->validate_functions.push_back(function);
2394 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2395}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002396
2397static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2398 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2399 bool skip = false;
2400 auto buffer_state = GetBufferState(device_data, buffer);
2401 if (!buffer_state) {
2402 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2403 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2404 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2405 } else {
2406 if (buffer_state->in_use.load()) {
2407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2408 __LINE__, VALIDATION_ERROR_00676, "DS",
2409 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2410 validation_error_map[VALIDATION_ERROR_00676]);
2411 }
2412 }
2413 return skip;
2414}
2415
2416bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2417 VK_OBJECT *obj_struct) {
2418 *image_view_state = GetImageViewState(device_data, image_view);
2419 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2420 if (GetDisables(device_data)->destroy_image_view) return false;
2421 bool skip = false;
2422 if (*image_view_state) {
2423 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2424 }
2425 return skip;
2426}
2427
2428void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2429 VK_OBJECT obj_struct) {
2430 // Any bound cmd buffers are now invalid
2431 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2432 (*GetImageViewMap(device_data)).erase(image_view);
2433}
2434
2435bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2436 *buffer_state = GetBufferState(device_data, buffer);
2437 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2438 if (GetDisables(device_data)->destroy_buffer) return false;
2439 bool skip = false;
2440 if (*buffer_state) {
2441 skip |= validateIdleBuffer(device_data, buffer);
2442 }
2443 return skip;
2444}
2445
2446void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2447 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2448 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2449 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2450 if (mem_info) {
2451 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2452 }
2453 }
2454 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2455 GetBufferMap(device_data)->erase(buffer_state->buffer);
2456}
2457
2458bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2459 VK_OBJECT *obj_struct) {
2460 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2461 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2462 if (GetDisables(device_data)->destroy_buffer_view) return false;
2463 bool skip = false;
2464 if (*buffer_view_state) {
2465 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2466 }
2467 return skip;
2468}
2469
2470void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2471 VK_OBJECT obj_struct) {
2472 // Any bound cmd buffers are now invalid
2473 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2474 GetBufferViewMap(device_data)->erase(buffer_view);
2475}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002476
2477bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2478 bool skip = false;
2479 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
2480 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2481 // Validate that DST buffer has correct usage flags set
2482 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2483 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2484 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2485 return skip;
2486}
2487
2488void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2489 std::function<bool()> function = [=]() {
2490 SetBufferMemoryValid(device_data, buffer_state, true);
2491 return false;
2492 };
2493 cb_node->validate_functions.push_back(function);
2494 // Update bindings between buffer and cmd buffer
2495 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2496 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2497}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002498
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002499bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2500 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002501 bool skip = false;
2502
2503 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002504 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
2505 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002506 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 -07002507 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
2508 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2509 "must be 0 and 1, respectively. %s",
2510 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2511 validation_error_map[VALIDATION_ERROR_01746]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002512 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002513 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002514
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002515 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
2516 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002517 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 -07002518 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
2519 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2520 "must be 0 and 1, respectively. %s",
2521 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2522 validation_error_map[VALIDATION_ERROR_01747]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002523 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002524 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002525
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002526 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2527 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2528 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2529 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
2530 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2531 "%d. For 3D images these must be 0 and 1, respectively. %s",
2532 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
2533 validation_error_map[VALIDATION_ERROR_01281]);
2534 }
2535 }
2536
2537 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2538 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
2539 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2540 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
2541 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2542 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2543 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
2544 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2545 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2546 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2547 }
2548
2549 // BufferOffset must be a multiple of 4
2550 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2551 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2552 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
2553 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2554 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2555 }
2556
2557 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2558 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2559 skip |= log_msg(
2560 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2561 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
2562 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2563 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2564 validation_error_map[VALIDATION_ERROR_01265]);
2565 }
2566
2567 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2568 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2569 skip |= log_msg(
2570 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2571 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
2572 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2573 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2574 validation_error_map[VALIDATION_ERROR_01266]);
2575 }
2576
2577 // subresource aspectMask must have exactly 1 bit set
2578 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2579 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2580 if (aspect_mask_bits.count() != 1) {
2581 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2582 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
2583 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2584 validation_error_map[VALIDATION_ERROR_01280]);
2585 }
2586
2587 // image subresource aspect bit must match format
2588 if (((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT)) &&
2589 (!vk_format_is_color(image_state->createInfo.format))) ||
2590 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT)) &&
2591 (!vk_format_has_depth(image_state->createInfo.format))) ||
2592 ((0 != (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2593 (!vk_format_has_stencil(image_state->createInfo.format)))) {
2594 skip |= log_msg(
2595 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2596 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
2597 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
2598 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
2599 validation_error_map[VALIDATION_ERROR_01279]);
2600 }
2601
2602 // Checks that apply only to compressed images
2603 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2604 // reserves a place for these compressed image checks. This block of code could move there once the image
2605 // stuff is moved into core validation.
2606 if (vk_format_is_compressed(image_state->createInfo.format)) {
2607 auto block_size = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2608
2609 // BufferRowLength must be a multiple of block width
2610 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002611 skip |= log_msg(
2612 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002613 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
2614 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2615 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002616 }
2617
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002618 // BufferRowHeight must be a multiple of block height
2619 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002620 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 -07002621 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
2622 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2623 "height (%d). %s.",
2624 function, i, pRegions[i].bufferImageHeight, block_size.height,
2625 validation_error_map[VALIDATION_ERROR_01272]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002626 }
2627
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002628 // image offsets must be multiples of block dimensions
2629 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
2630 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0)) {
2631 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2632 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
2633 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2634 "width & height (%d, %d). %s.",
2635 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2636 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002637 }
2638
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002639 // bufferOffset must be a multiple of block size (linear bytes)
2640 size_t block_size_in_bytes = vk_format_get_size(image_state->createInfo.format);
2641 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 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_01274, "IMAGE",
2644 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
2645 ") must be a multiple of the compressed image's texel block "
2646 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
2647 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2648 validation_error_map[VALIDATION_ERROR_01274]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002649 }
Dave Houlton67e9b532017-03-02 17:00:10 -07002650
2651 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
2652 if ((vk_safe_modulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
2653 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != image_state->createInfo.extent.width)) {
2654 skip |=
2655 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2656 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01275, "IMAGE",
2657 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width (%d), or "
2658 "when added to offset.x (%d) must equal the image subresource width (%d). %s.",
2659 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
2660 image_state->createInfo.extent.width, validation_error_map[VALIDATION_ERROR_01275]);
2661 }
2662
2663 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
2664 if ((vk_safe_modulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
2665 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != image_state->createInfo.extent.height)) {
2666 skip |= log_msg(
2667 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2668 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01276, "IMAGE",
2669 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height (%d), or "
2670 "when added to offset.y (%d) must equal the image subresource height (%d). %s.",
2671 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
2672 image_state->createInfo.extent.height, validation_error_map[VALIDATION_ERROR_01276]);
2673 }
2674
2675 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
2676 if ((vk_safe_modulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
2677 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != image_state->createInfo.extent.depth)) {
2678 skip |=
2679 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2680 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01277, "IMAGE",
2681 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth (%d), or "
2682 "when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
2683 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
2684 image_state->createInfo.extent.depth, validation_error_map[VALIDATION_ERROR_01277]);
2685 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002686 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002687 }
2688
2689 return skip;
2690}
2691
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002692static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
2693 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002694 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002695 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002696
2697 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002698 VkExtent3D extent = pRegions[i].imageExtent;
2699 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002700
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002701 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
2702 {
2703 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2704 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
2705 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
2706 extent.height, extent.depth);
2707 }
2708
2709 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
2710
2711 // 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 -07002712 if (vk_format_is_compressed(image_info->format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002713 auto block_extent = vk_format_compressed_texel_block_extents(image_info->format);
2714 if (image_extent.width % block_extent.width) {
2715 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
2716 }
2717 if (image_extent.height % block_extent.height) {
2718 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
2719 }
2720 if (image_extent.depth % block_extent.depth) {
2721 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
2722 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002723 }
2724
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002725 if (ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002726 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 -07002727 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002728 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002729 }
2730 }
2731
2732 return skip;
2733}
2734
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002735static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2736 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2737 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2738 bool skip = false;
2739
2740 VkDeviceSize buffer_size = buff_state->createInfo.size;
2741
2742 for (uint32_t i = 0; i < regionCount; i++) {
2743 VkExtent3D copy_extent = pRegions[i].imageExtent;
2744
2745 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2746 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2747 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2748
Dave Houltonf3229d52017-02-21 15:59:08 -07002749 // Handle special buffer packing rules for specific depth/stencil formats
2750 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2751 unit_size = vk_format_get_size(VK_FORMAT_S8_UINT);
2752 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2753 switch (image_state->createInfo.format) {
2754 case VK_FORMAT_D16_UNORM_S8_UINT:
2755 unit_size = vk_format_get_size(VK_FORMAT_D16_UNORM);
2756 break;
2757 case VK_FORMAT_D32_SFLOAT_S8_UINT:
2758 unit_size = vk_format_get_size(VK_FORMAT_D32_SFLOAT);
2759 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002760 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07002761 case VK_FORMAT_D24_UNORM_S8_UINT:
2762 unit_size = 4;
2763 break;
2764 default:
2765 break;
2766 }
2767 }
2768
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002769 if (vk_format_is_compressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002770 // Switch to texel block units, rounding up for any partially-used blocks
2771 auto block_dim = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2772 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
2773 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
2774
2775 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
2776 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
2777 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002778 }
2779
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002780 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
2781 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2782 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
2783 // TODO: Issure warning here? Already warned in ValidateImageBounds()...
2784 } else {
2785 // Calculate buffer offset of final copied byte, + 1.
2786 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
2787 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2788 max_buffer_offset *= unit_size; // convert to bytes
2789 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002790
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002791 if (buffer_size < max_buffer_offset) {
2792 skip |=
2793 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2794 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
2795 i, buffer_size, validation_error_map[msg_code]);
2796 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002797 }
2798 }
2799
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002800 return skip;
2801}
2802
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002803bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002804 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002805 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002806 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2807 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2808
2809 // Validate command buffer state
2810 if (CB_RECORDING != cb_node->state) {
2811 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2812 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2813 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2814 validation_error_map[VALIDATION_ERROR_01258]);
2815 } else {
2816 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2817 }
2818
2819 // Command pool must support graphics, compute, or transfer operations
2820 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2821
2822 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2823 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2824 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2825 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2826 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2827 "or transfer capabilities. %s.",
2828 validation_error_map[VALIDATION_ERROR_01259]);
2829 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002830 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002831 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002832 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002833 VALIDATION_ERROR_01246);
2834
2835 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2836 VALIDATION_ERROR_01249);
2837 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002838 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002839
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002840 // Validate that SRC image & DST buffer have correct usage flags set
2841 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2842 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002843 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002844 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002845 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
2846 for (uint32_t i = 0; i < regionCount; ++i) {
2847 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, pRegions[i].imageSubresource, srcImageLayout,
2848 VALIDATION_ERROR_01251);
2849 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
2850 "CmdCopyImageToBuffer");
2851 }
2852 return skip;
2853}
2854
2855void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002856 BUFFER_STATE *dst_buffer_state) {
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002857 // Update bindings between buffer/image and cmd buffer
2858 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002859 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002860
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002861 std::function<bool()> function = [=]() {
2862 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
2863 };
2864 cb_node->validate_functions.push_back(function);
2865 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002866 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002867 return false;
2868 };
2869 cb_node->validate_functions.push_back(function);
2870
2871 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002872}
2873
2874bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002875 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002876 const VkBufferImageCopy *pRegions, const char *func_name) {
2877 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2878 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
2879
2880 // Validate command buffer state
2881 if (CB_RECORDING != cb_node->state) {
2882 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2883 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
2884 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
2885 validation_error_map[VALIDATION_ERROR_01240]);
2886 } else {
2887 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
2888 }
2889
2890 // Command pool must support graphics, compute, or transfer operations
2891 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2892 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2893 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2894 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2895 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
2896 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
2897 "or transfer capabilities. %s.",
2898 validation_error_map[VALIDATION_ERROR_01241]);
2899 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002900 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002901 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002902 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002903 VALIDATION_ERROR_01227);
2904 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
2905 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002906 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002907 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002908 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002909 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2910 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
2911 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002912 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
2913 for (uint32_t i = 0; i < regionCount; ++i) {
2914 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, pRegions[i].imageSubresource, dstImageLayout,
2915 VALIDATION_ERROR_01234);
2916 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
2917 "vkCmdCopyBufferToImage()");
2918 }
2919 return skip;
2920}
2921
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002922void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002923 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002924 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002925 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002926 std::function<bool()> function = [=]() {
2927 SetImageMemoryValid(device_data, dst_image_state, true);
2928 return false;
2929 };
2930 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002931 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002932 cb_node->validate_functions.push_back(function);
2933
2934 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002935}
Mike Weiblen672b58b2017-02-21 14:32:53 -07002936
2937bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
2938 const auto report_data = core_validation::GetReportData(device_data);
2939 bool skip = false;
2940 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
2941
2942 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
2943 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
2944 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
2945 if (aspect_mask_bits.count() != 1) {
2946 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2947 VALIDATION_ERROR_00733, "IMAGE",
2948 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
2949 validation_error_map[VALIDATION_ERROR_00733]);
2950 }
2951
2952 IMAGE_STATE *image_entry = GetImageState(device_data, image);
2953 if (!image_entry) {
2954 return skip;
2955 }
2956
2957 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
2958 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
2959 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2960 __LINE__, VALIDATION_ERROR_00732, "IMAGE",
2961 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
2962 validation_error_map[VALIDATION_ERROR_00732]);
2963 }
2964
2965 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
2966 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
2967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2968 __LINE__, VALIDATION_ERROR_00739, "IMAGE",
2969 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
2970 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
2971 }
2972
2973 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
2974 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
2975 skip |= log_msg(
2976 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
2977 VALIDATION_ERROR_00740, "IMAGE", "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
2978 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
2979 }
2980
2981 // VU 00741: subresource's aspect must be compatible with image's format.
2982 const VkFormat img_format = image_entry->createInfo.format;
2983 if (vk_format_is_color(img_format)) {
2984 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
2985 skip |= log_msg(
2986 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
2987 VALIDATION_ERROR_00741, "IMAGE",
2988 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
2989 validation_error_map[VALIDATION_ERROR_00741]);
2990 }
2991 } else if (vk_format_is_depth_or_stencil(img_format)) {
2992 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
2993 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2994 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2995 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
2996 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
2997 validation_error_map[VALIDATION_ERROR_00741]);
2998 }
2999 }
3000 return skip;
3001}