blob: 503561748f07b45bbc76221348cbd016eadb0500 [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>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070020 */
21
22// Allow use of STL min and max functions in Windows
23#define NOMINMAX
24
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
26
27#include "vk_enum_string_helper.h"
28#include "vk_layer_data.h"
29#include "vk_layer_utils.h"
30#include "vk_layer_logging.h"
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
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600377 bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
378 // TBD: anything to do for metadata bit? or no bits set?
379 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
380 if (!vk_format_is_color(format)) return false;
381 }
382 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
383 if (!vk_format_has_depth(format)) return false;
384 }
385 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
386 if (!vk_format_has_stencil(format)) return false;
387 }
388 return true;
389}
390
Mike Weiblen62d08a32017-03-07 22:18:27 -0700391// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
392bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
393 VkImageUsageFlags usage_flags, const char *func_name) {
394 const auto report_data = core_validation::GetReportData(device_data);
395 bool skip = false;
396 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
397 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
398
399 switch (layout) {
400 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
401 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
402 msg_code = VALIDATION_ERROR_00303;
403 }
404 break;
405 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
406 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
407 msg_code = VALIDATION_ERROR_00304;
408 }
409 break;
410 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
411 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
412 msg_code = VALIDATION_ERROR_00305;
413 }
414 break;
415 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
416 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
417 msg_code = VALIDATION_ERROR_00306;
418 }
419 break;
420 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
421 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
422 msg_code = VALIDATION_ERROR_00307;
423 }
424 break;
425 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
426 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
427 msg_code = VALIDATION_ERROR_00308;
428 }
429 break;
430 default:
431 // Other VkImageLayout values do not have VUs defined in this context.
432 break;
433 }
434
435 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, msg_code,
437 "DS", "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32
438 ". %s",
439 func_name, img_barrier, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
440 (uint64_t)(img_barrier->image), usage_flags, validation_error_map[msg_code]);
441 }
442 return skip;
443}
444
445// Verify image barriers are compatible with the images they reference.
446bool ValidateBarriersToImages(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t imageMemoryBarrierCount,
447 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700448 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700449 bool skip = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700450 uint32_t level_count = 0;
451 uint32_t layer_count = 0;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700452
Mike Weiblen62d08a32017-03-07 22:18:27 -0700453 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
454 auto img_barrier = &pImageMemoryBarriers[i];
455 if (!img_barrier) continue;
456
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700457 // TODO: Do not iterate over every possibility - consolidate where possible
Mike Weiblen62d08a32017-03-07 22:18:27 -0700458 ResolveRemainingLevelsLayers(device_data, &level_count, &layer_count, img_barrier->subresourceRange,
459 GetImageState(device_data, img_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460
Mike Weiblen62d08a32017-03-07 22:18:27 -0700461 for (uint32_t j = 0; j < level_count; j++) {
462 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
463 for (uint32_t k = 0; k < layer_count; k++) {
464 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
465 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
466 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
467 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
468 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700469 }
470 }
Mike Weiblen62d08a32017-03-07 22:18:27 -0700471
472 IMAGE_STATE *image_state = GetImageState(device_data, img_barrier->image);
473 if (image_state) {
474 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
475 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
476 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
477 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700478 }
479 return skip;
480}
481
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700482void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
483 const VkImageMemoryBarrier *pImgMemBarriers) {
484 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
485 uint32_t levelCount = 0;
486 uint32_t layerCount = 0;
487
488 for (uint32_t i = 0; i < memBarrierCount; ++i) {
489 auto mem_barrier = &pImgMemBarriers[i];
490 if (!mem_barrier) continue;
491 // TODO: Do not iterate over every possibility - consolidate where possible
492 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
493 GetImageState(device_data, mem_barrier->image));
494
495 for (uint32_t j = 0; j < levelCount; j++) {
496 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
497 for (uint32_t k = 0; k < layerCount; k++) {
498 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
499 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
500 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
501 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
502 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
503 }
504 }
505 }
506}
507
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700508bool VerifySourceImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage srcImage, VkImageSubresourceLayers subLayers,
509 VkImageLayout srcImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700510 const auto report_data = core_validation::GetReportData(device_data);
511 bool skip_call = false;
512
513 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
514 uint32_t layer = i + subLayers.baseArrayLayer;
515 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
516 IMAGE_CMD_BUF_LAYOUT_NODE node;
517 if (!FindCmdBufLayout(device_data, cb_node, srcImage, sub, node)) {
518 SetLayout(device_data, cb_node, srcImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(srcImageLayout, srcImageLayout));
519 continue;
520 }
521 if (node.layout != srcImageLayout) {
522 // TODO: Improve log message in the next pass
523 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
524 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
525 "Cannot copy from an image whose source layout is %s "
526 "and doesn't match the current layout %s.",
527 string_VkImageLayout(srcImageLayout), string_VkImageLayout(node.layout));
528 }
529 }
530 if (srcImageLayout != VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) {
531 if (srcImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
532 // 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 -0700533 auto image_state = GetImageState(device_data, srcImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700534 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
535 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
536 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
537 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
538 "Layout for input image should be TRANSFER_SRC_OPTIMAL instead of GENERAL.");
539 }
540 } else {
541 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
542 "DS", "Layout for input image is %s but can only be TRANSFER_SRC_OPTIMAL or GENERAL. %s",
543 string_VkImageLayout(srcImageLayout), validation_error_map[msgCode]);
544 }
545 }
546 return skip_call;
547}
548
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700549bool VerifyDestImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage destImage, VkImageSubresourceLayers subLayers,
550 VkImageLayout destImageLayout, UNIQUE_VALIDATION_ERROR_CODE msgCode) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700551 const auto report_data = core_validation::GetReportData(device_data);
552 bool skip_call = false;
553
554 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
555 uint32_t layer = i + subLayers.baseArrayLayer;
556 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
557 IMAGE_CMD_BUF_LAYOUT_NODE node;
558 if (!FindCmdBufLayout(device_data, cb_node, destImage, sub, node)) {
559 SetLayout(device_data, cb_node, destImage, sub, IMAGE_CMD_BUF_LAYOUT_NODE(destImageLayout, destImageLayout));
560 continue;
561 }
562 if (node.layout != destImageLayout) {
563 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
564 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
565 "Cannot copy from an image whose dest layout is %s and "
566 "doesn't match the current layout %s.",
567 string_VkImageLayout(destImageLayout), string_VkImageLayout(node.layout));
568 }
569 }
570 if (destImageLayout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
571 if (destImageLayout == VK_IMAGE_LAYOUT_GENERAL) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700572 auto image_state = GetImageState(device_data, destImage);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700573 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
574 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
575 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
576 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
577 "Layout for output image should be TRANSFER_DST_OPTIMAL instead of GENERAL.");
578 }
579 } else {
580 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, msgCode,
581 "DS", "Layout for output image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL. %s",
582 string_VkImageLayout(destImageLayout), validation_error_map[msgCode]);
583 }
584 }
585 return skip_call;
586}
587
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700588void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
589 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700590 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700591 if (!renderPass) return;
592
593 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
594 if (framebuffer_state) {
595 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
596 auto image_view = framebuffer_state->createInfo.pAttachments[i];
597 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
598 }
599 }
600}
601
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700602bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700603 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
604 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700605 const debug_report_data *report_data = core_validation::GetReportData(device_data);
606
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600607 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700608 skip_call |=
609 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
610 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
611 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600612
613 return skip_call;
614 }
615
616 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
617
618 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
619 std::stringstream ss;
620 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
621 skip_call |=
622 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
623 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
624
625 return skip_call;
626 }
627
628 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
629 std::stringstream ss;
630 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
631 skip_call |=
632 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
633 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
634
635 return skip_call;
636 }
637
638 // Validate that format supports usage as color attachment
639 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
640 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
641 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
642 std::stringstream ss;
643 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
644 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
645 skip_call |=
646 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
647 VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
648 }
649 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
650 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
651 std::stringstream ss;
652 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
653 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
654 skip_call |=
655 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
656 VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
657 }
658 }
659
660 // Validate that format supports usage as depth/stencil attachment
661 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
662 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
663 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
664 std::stringstream ss;
665 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
666 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
667 skip_call |=
668 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
669 VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
670 }
671 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
672 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
673 std::stringstream ss;
674 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
675 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
676 skip_call |=
677 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
678 VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
679 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700680 }
681
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700682 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
683 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700684
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700685 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700686 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
687
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700688 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
689 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
690 VALIDATION_ERROR_00716, "Image",
691 "CreateImage extent is 0 for at least one required dimension for image: "
692 "Width = %d Height = %d Depth = %d. %s",
693 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
694 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700695 }
696
697 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
698 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700699 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
700 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
701 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700702 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
703 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
704 "CreateImage extents exceed allowable limits for format: "
705 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
706 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700707 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
708 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700709 }
710
711 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
712 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
713 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
714 (uint64_t)imageGranularity) &
715 ~(uint64_t)imageGranularity;
716
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700717 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700718 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
719 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
720 "CreateImage resource size exceeds allowable maximum "
721 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700722 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700723 }
724
725 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700726 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700727 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
728 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
729 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700730 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700731 }
732
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700733 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700734 skip_call |= log_msg(
735 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
736 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700737 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700738 }
739
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700740 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700741 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
742 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700743 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700744 validation_error_map[VALIDATION_ERROR_02138]);
745 }
746
747 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
748 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
749 VALIDATION_ERROR_00731, "Image",
750 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
751 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
752 validation_error_map[VALIDATION_ERROR_00731]);
753 }
754
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600755 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
756 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
757 VALIDATION_ERROR_02143, "DS",
758 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
759 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
760 validation_error_map[VALIDATION_ERROR_02143]);
761 }
762
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600763 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
764 skip_call |=
765 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
766 DRAWSTATE_INVALID_FEATURE, "DS",
767 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
768 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
769 }
770
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700771 return skip_call;
772}
773
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700774void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700775 IMAGE_LAYOUT_NODE image_state;
776 image_state.layout = pCreateInfo->initialLayout;
777 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700778 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 -0700779 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700780 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
781 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700782}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700783
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700784bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700785 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700786 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700787 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
788 if (disabled->destroy_image) return false;
789 bool skip = false;
790 if (*image_state) {
791 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
792 }
793 return skip;
794}
795
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700796void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700797 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
798 // Clean up memory mapping, bindings and range references for image
799 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700800 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700801 if (mem_info) {
802 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
803 }
804 }
805 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
806 // Remove image from imageMap
807 core_validation::GetImageMap(device_data)->erase(image);
808 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
809 core_validation::GetImageSubresourceMap(device_data);
810
811 const auto &sub_entry = imageSubresourceMap->find(image);
812 if (sub_entry != imageSubresourceMap->end()) {
813 for (const auto &pair : sub_entry->second) {
814 core_validation::GetImageLayoutMap(device_data)->erase(pair);
815 }
816 imageSubresourceMap->erase(sub_entry);
817 }
818}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700819
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700820bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700821 bool skip = false;
822 const debug_report_data *report_data = core_validation::GetReportData(device_data);
823
824 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
825 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
826 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
827 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
828 }
829
830 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
831 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
832 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
833 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
834 validation_error_map[VALIDATION_ERROR_01088]);
835 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
836 char const str[] = "vkCmdClearColorImage called with compressed image.";
837 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
838 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
839 validation_error_map[VALIDATION_ERROR_01088]);
840 }
841
842 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
843 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
844 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
845 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
846 validation_error_map[VALIDATION_ERROR_01084]);
847 }
848 return skip;
849}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700850
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700851void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700852 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
853 // internal state to the actual values.
854 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
855 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
856 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700857
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700858 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
859 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700860 }
861}
862
863// 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 -0700864void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
865 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700866 *levels = range.levelCount;
867 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700868 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
869 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
870 }
871 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
872 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700873 }
874}
875
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700876bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700877 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
878 bool skip = false;
879 const debug_report_data *report_data = core_validation::GetReportData(device_data);
880
881 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700882 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700883
884 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
885 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700886 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
887 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
888 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
889 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
890 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
891 }
892 } else {
893 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
894 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
895 error_code = VALIDATION_ERROR_01101;
896 } else {
897 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
898 }
899 skip |=
900 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__, error_code, "DS",
901 "%s: Layout for cleared image is %s but can only be "
902 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
903 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
904 }
905 }
906
907 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
908 uint32_t level = level_index + resolved_range.baseMipLevel;
909 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
910 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
911 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
912 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700913 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700914 if (node.layout != dest_image_layout) {
915 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
916 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
917 error_code = VALIDATION_ERROR_01100;
918 } else {
919 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
920 }
921 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
922 __LINE__, error_code, "DS",
923 "%s: Cannot clear an image whose layout is %s and "
924 "doesn't match the current layout %s. %s",
925 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
926 validation_error_map[error_code]);
927 }
928 }
929 }
930 }
931
932 return skip;
933}
934
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700935void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
936 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700937 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700938 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700939
940 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
941 uint32_t level = level_index + resolved_range.baseMipLevel;
942 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
943 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
944 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
945 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700946 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
947 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 -0700948 }
949 }
950 }
951}
952
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700953bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700954 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
955 bool skip = false;
956 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700957 auto cb_node = GetCBNode(dev_data, commandBuffer);
958 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700959 if (cb_node && image_state) {
960 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
961 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
962 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
963 for (uint32_t i = 0; i < rangeCount; ++i) {
964 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700965 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700966 }
967 }
968 return skip;
969}
970
971// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700972void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
973 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700974 auto cb_node = GetCBNode(dev_data, commandBuffer);
975 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700976 if (cb_node && image_state) {
977 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
978 std::function<bool()> function = [=]() {
979 SetImageMemoryValid(dev_data, image_state, true);
980 return false;
981 };
982 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700983 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700984 for (uint32_t i = 0; i < rangeCount; ++i) {
985 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
986 }
987 }
988}
989
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700990bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
991 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700992 const VkImageSubresourceRange *pRanges) {
993 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700994 const debug_report_data *report_data = core_validation::GetReportData(device_data);
995
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700996 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700997 auto cb_node = GetCBNode(device_data, commandBuffer);
998 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700999 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001000 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
1001 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
1002 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001003 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001004 skip |=
1005 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001006 // Image aspect must be depth or stencil or both
1007 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1008 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1009 char const str[] =
1010 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
1011 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
1012 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1013 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
1014 }
1015 }
1016 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
1017 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
1018 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1019 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
1020 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001021 }
1022 }
1023 return skip;
1024}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001025
1026// Returns true if [x, xoffset] and [y, yoffset] overlap
1027static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1028 bool result = false;
1029 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1030 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1031
1032 if (intersection_max > intersection_min) {
1033 result = true;
1034 }
1035 return result;
1036}
1037
1038// Returns true if two VkImageCopy structures overlap
1039static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1040 bool result = false;
1041 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1042 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1043 dst->dstSubresource.layerCount))) {
1044 result = true;
1045 switch (type) {
1046 case VK_IMAGE_TYPE_3D:
1047 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1048 // Intentionally fall through to 2D case
1049 case VK_IMAGE_TYPE_2D:
1050 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1051 // Intentionally fall through to 1D case
1052 case VK_IMAGE_TYPE_1D:
1053 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1054 break;
1055 default:
1056 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1057 assert(false);
1058 }
1059 }
1060 return result;
1061}
1062
1063// Returns true if offset and extent exceed image extents
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001064static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001065 bool result = false;
1066 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001067 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1068 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
1069 result = true;
1070 }
1071 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1072 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
1073 result = true;
1074 }
1075 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1076 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
1077 result = true;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001078 }
1079 return result;
1080}
1081
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001082// Test if two VkExtent3D structs are equivalent
1083static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1084 bool result = true;
1085 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1086 (extent->depth != other_extent->depth)) {
1087 result = false;
1088 }
1089 return result;
1090}
1091
1092// Returns the image extent of a specific subresource.
1093static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1094 const uint32_t mip = subresource->mipLevel;
1095 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001096 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
1097 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1098 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1099 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001100 return extent;
1101}
1102
1103// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001104static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001105 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1106}
1107
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001108// Test if the extent argument has any dimensions set to 0.
1109static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1110 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1111}
1112
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001113// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1114static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1115 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1116 VkExtent3D granularity = {0, 0, 0};
1117 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1118 if (pPool) {
1119 granularity =
1120 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
1121 if (vk_format_is_compressed(img->createInfo.format)) {
Mark Lobodzinski13086442017-02-24 08:53:14 -07001122 auto block_size = vk_format_compressed_texel_block_extents(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001123 granularity.width *= block_size.width;
1124 granularity.height *= block_size.height;
1125 }
1126 }
1127 return granularity;
1128}
1129
1130// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1131static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1132 bool valid = true;
1133 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
1134 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
1135 valid = false;
1136 }
1137 return valid;
1138}
1139
1140// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1141static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1142 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1143 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1144 bool skip = false;
1145 VkExtent3D offset_extent = {};
1146 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1147 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1148 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001149 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001150 // 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 -07001151 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001152 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1153 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1154 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1155 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1156 function, i, member, offset->x, offset->y, offset->z);
1157 }
1158 } else {
1159 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1160 // integer multiples of the image transfer granularity.
1161 if (IsExtentAligned(&offset_extent, granularity) == false) {
1162 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1163 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1164 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1165 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1166 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1167 granularity->depth);
1168 }
1169 }
1170 return skip;
1171}
1172
1173// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1174static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1175 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1176 const uint32_t i, const char *function, const char *member) {
1177 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1178 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001179 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001180 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1181 // subresource extent.
1182 if (IsExtentEqual(extent, subresource_extent) == false) {
1183 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1184 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1185 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1186 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1187 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1188 subresource_extent->height, subresource_extent->depth);
1189 }
1190 } else {
1191 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1192 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1193 // subresource extent dimensions.
1194 VkExtent3D offset_extent_sum = {};
1195 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1196 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1197 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1198 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1199 skip |=
1200 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1201 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1202 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1203 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1204 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1205 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1206 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1207 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1208 }
1209 }
1210 return skip;
1211}
1212
1213// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1214static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1215 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1216 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1217
1218 bool skip = false;
1219 if (vk_safe_modulo(value, granularity) != 0) {
1220 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1221 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1222 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1223 "transfer granularity width (%d).",
1224 function, i, member, value, granularity);
1225 }
1226 return skip;
1227}
1228
1229// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1230static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1231 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1232 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1233 bool skip = false;
1234 if (vk_safe_modulo(value, granularity) != 0) {
1235 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
1236 DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1237 "%s: pRegion[%d].%s (%" PRIdLEAST64
1238 ") must be an even integer multiple of this command buffer's queue family image transfer "
1239 "granularity width (%d).",
1240 function, i, member, value, granularity);
1241 }
1242 return skip;
1243}
1244
1245// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1246bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1247 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1248 const uint32_t i, const char *function) {
1249 bool skip = false;
1250 if (vk_format_is_compressed(img->createInfo.format) == true) {
1251 // TODO: Add granularity checking for compressed formats
1252
1253 // bufferRowLength must be a multiple of the compressed texel block width
1254 // bufferImageHeight must be a multiple of the compressed texel block height
1255 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1256 // bufferOffset must be a multiple of the compressed texel block size in bytes
1257 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1258 // must equal the image subresource width
1259 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1260 // must equal the image subresource height
1261 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1262 // must equal the image subresource depth
1263 } else {
1264 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1265 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1266 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1267 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1268 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1269 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1270 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1271 i, function, "imageExtent");
1272 }
1273 return skip;
1274}
1275
1276// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1277bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1278 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1279 const char *function) {
1280 bool skip = false;
1281 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1282 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1283 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1284 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1285 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1286 function, "extent");
1287 return skip;
1288}
1289
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001290bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001291 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1292 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001293 bool skip = false;
1294 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1295 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1296
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001297 for (uint32_t i = 0; i < region_count; i++) {
1298 if (regions[i].srcSubresource.layerCount == 0) {
1299 std::stringstream ss;
1300 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1301 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1302 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1303 ss.str().c_str());
1304 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001305
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001306 if (regions[i].dstSubresource.layerCount == 0) {
1307 std::stringstream ss;
1308 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1309 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1310 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1311 ss.str().c_str());
1312 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001313
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001314 // For each region the layerCount member of srcSubresource and dstSubresource must match
1315 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1316 std::stringstream ss;
1317 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1318 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1319 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1320 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1321 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001322
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001323 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1324 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1325 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1326 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1327 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1328 validation_error_map[VALIDATION_ERROR_01197]);
1329 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001330
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001331 // For each region, the aspectMask member of srcSubresource must be present in the source image
1332 if (!VerifyAspectsPresent(regions[i].srcSubresource.aspectMask, src_image_state->createInfo.format)) {
1333 std::stringstream ss;
1334 ss << "vkCmdCopyImage: pRegion[" << i
1335 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1336 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1337 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01200, "IMAGE", "%s. %s",
1338 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01200]);
1339 }
1340
1341 // For each region, the aspectMask member of dstSubresource must be present in the destination image
1342 if (!VerifyAspectsPresent(regions[i].dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
1343 std::stringstream ss;
1344 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1345 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1346 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01201, "IMAGE", "%s. %s",
1347 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01201]);
1348 }
1349
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001350 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1351 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1352 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1353 std::stringstream ss;
1354 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
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_01222, "IMAGE", "%s. %s",
1357 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1358 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001359
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001360 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1361 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1362 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1363 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1364 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1366 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1367 validation_error_map[VALIDATION_ERROR_01221]);
1368 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001369
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001370 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1371 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1372 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1373 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1374 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1375 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1376 std::stringstream ss;
1377 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1378 << "] baseArrayLayer was not zero or layerCount was not 1.";
1379 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1380 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1381 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1382 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001383
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001384 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1385 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1386 std::stringstream ss;
1387 ss << "vkCmdCopyImage: pRegions[" << i
1388 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1390 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1391 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1392 }
1393 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1394 std::stringstream ss;
1395 ss << "vkCmdCopyImage: pRegions[" << i
1396 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1397 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1398 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1399 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1400 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001401
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001402 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1403 // image was created
1404 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1405 src_image_state->createInfo.arrayLayers) {
1406 std::stringstream ss;
1407 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1408 << "] baseArrayLayer + layerCount is "
1409 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1410 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1411 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1412 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1413 }
1414 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1415 dst_image_state->createInfo.arrayLayers) {
1416 std::stringstream ss;
1417 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1418 << "] baseArrayLayer + layerCount is "
1419 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1421 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1422 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1423 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001424
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001425 // 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 -07001426 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &(src_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001427 std::stringstream ss;
1428 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1429 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1430 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1431 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1432 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001433
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001434 // 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 -07001435 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &(dst_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001436 std::stringstream ss;
1437 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1438 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1439 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1440 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1441 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001442
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001443 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1444 // must not overlap in memory
1445 if (src_image_state->image == dst_image_state->image) {
1446 for (uint32_t j = 0; j < region_count; j++) {
1447 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1448 std::stringstream ss;
1449 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1450 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1451 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1452 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001453 }
1454 }
1455 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001456 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001457
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001458 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1459 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1460 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1461 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1462 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1463 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1464 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1465 skip |=
1466 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1467 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1468 }
1469 } else {
1470 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1471 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1472 if (srcSize != destSize) {
1473 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1474 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1475 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1476 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001477 }
1478 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001479
Dave Houlton33c22b72017-02-28 13:16:02 -07001480 // Source and dest image sample counts must match
1481 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
1482 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
1483 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001484 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01185, "IMAGE", "%s %s", str,
1485 validation_error_map[VALIDATION_ERROR_01185]);
Dave Houlton33c22b72017-02-28 13:16:02 -07001486 }
1487
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001488 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1489 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1490 // Validate that SRC & DST images have correct usage flags set
1491 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1492 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1493 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1494 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
1495 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1496 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1497 for (uint32_t i = 0; i < region_count; ++i) {
1498 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, regions[i].srcSubresource, src_image_layout,
1499 VALIDATION_ERROR_01180);
1500 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, regions[i].dstSubresource, dst_image_layout,
1501 VALIDATION_ERROR_01183);
1502 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1503 "vkCmdCopyImage()");
1504 }
1505
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001506 return skip;
1507}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001508
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001509void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1510 IMAGE_STATE *dst_image_state) {
1511 // Update bindings between images and cmd buffer
1512 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1513 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07001514 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001515 cb_node->validate_functions.push_back(function);
1516 function = [=]() {
1517 SetImageMemoryValid(device_data, dst_image_state, true);
1518 return false;
1519 };
1520 cb_node->validate_functions.push_back(function);
1521 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1522}
1523
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001524// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1525// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1526// to that same cmd buffer by separate thread are not changing state from underneath us
1527// Track the last cmd buffer touched by this thread
1528static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1529 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1530 if (pCB->drawCount[i]) return true;
1531 }
1532 return false;
1533}
1534
1535// Returns true if sub_rect is entirely contained within rect
1536static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1537 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1538 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1539 return false;
1540 return true;
1541}
1542
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001543bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1544 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001545 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001546 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1547
1548 bool skip = false;
1549 if (cb_node) {
1550 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001551 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001552 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1553 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1554 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1555 // 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 -07001556 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
1557 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001558 skip |=
1559 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1560 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1561 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1562 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1563 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001564 }
1565 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1566 }
1567
1568 // Validate that attachment is in reference list of active subpass
1569 if (cb_node->activeRenderPass) {
1570 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1571 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001572 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001573
1574 for (uint32_t i = 0; i < attachmentCount; i++) {
1575 auto clear_desc = &pAttachments[i];
1576 VkImageView image_view = VK_NULL_HANDLE;
1577
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001578 if (0 == clear_desc->aspectMask) {
1579 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1580 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
1581 validation_error_map[VALIDATION_ERROR_01128]);
1582 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1583 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1584 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
1585 validation_error_map[VALIDATION_ERROR_01126]);
1586 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001587 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001588 skip |=
1589 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1590 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01114, "DS",
1591 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1592 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001593 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1594 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001595 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1596 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1597 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1598 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001599 } else {
1600 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001601 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001602 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001603 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1604 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1605 char const str[] =
1606 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1607 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1608 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
1609 validation_error_map[VALIDATION_ERROR_01125]);
1610 }
1611 } else { // Must be depth and/or stencil
1612 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1613 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1614 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1615 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1616 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
1617 validation_error_map[VALIDATION_ERROR_01127]);
1618 }
1619 if (!subpass_desc->pDepthStencilAttachment ||
1620 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1621 skip |= log_msg(
1622 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1623 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
1624 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001625 } else {
1626 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1627 }
1628 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001629 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001630 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001631 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001632 // The rectangular region specified by a given element of pRects must be contained within the render area of
1633 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001634 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
1635 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
1636 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001637 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1638 __LINE__, VALIDATION_ERROR_01115, "DS",
1639 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1640 "the current render pass instance. %s",
1641 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001642 }
1643 // The layers specified by a given element of pRects must be contained within every attachment that
1644 // pAttachments refers to
1645 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1646 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1647 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1648 skip |=
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001649 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1650 __LINE__, VALIDATION_ERROR_01116, "DS",
1651 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1652 "pAttachment[%d]. %s",
1653 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001654 }
1655 }
1656 }
1657 }
1658 }
1659 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001660}
1661
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001662bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001663 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001664 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001665 bool skip = false;
1666 if (cb_node && src_image_state && dst_image_state) {
1667 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1668 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
1669 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1670 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001671
1672 // For each region, the number of layers in the image subresource should not be zero
1673 // For each region, src and dest image aspect must be color only
1674 for (uint32_t i = 0; i < regionCount; i++) {
1675 if (pRegions[i].srcSubresource.layerCount == 0) {
1676 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001677 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 -07001678 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1679 "IMAGE", str);
1680 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001681 if (pRegions[i].dstSubresource.layerCount == 0) {
1682 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001683 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 -07001684 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1685 "IMAGE", str);
1686 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001687 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1688 skip |= log_msg(
1689 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1690 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1691 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1692 validation_error_map[VALIDATION_ERROR_01339]);
1693 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001694 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1695 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1696 char const str[] =
1697 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1698 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1699 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1700 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1701 }
1702 }
1703
1704 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1705 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001706 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 -07001707 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1708 "IMAGE", str);
1709 }
1710 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1711 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001712 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 -07001713 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1714 str);
1715 }
1716 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1717 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1718 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1719 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1720 str, validation_error_map[VALIDATION_ERROR_01320]);
1721 }
1722 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1723 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1724 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1725 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1726 str, validation_error_map[VALIDATION_ERROR_01321]);
1727 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001728 } else {
1729 assert(0);
1730 }
1731 return skip;
1732}
1733
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001734void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1735 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001736 // Update bindings between images and cmd buffer
1737 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1738 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1739
1740 std::function<bool()> function = [=]() {
1741 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1742 };
1743 cb_node->validate_functions.push_back(function);
1744 function = [=]() {
1745 SetImageMemoryValid(device_data, dst_image_state, true);
1746 return false;
1747 };
1748 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001749 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001750}
1751
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001752bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001753 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1754 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1755
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001756 bool skip = false;
1757 if (cb_node && src_image_state && dst_image_state) {
1758 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001759 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001760 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001761 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001762 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1763 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1764 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001765 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001766 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001767 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001768 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1769 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001770
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001771 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001772 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001773 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1774 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1775 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1776 std::stringstream ss;
1777 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1778 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1779 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1780 "%s", ss.str().c_str());
1781 }
1782 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1783 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1784 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1785 std::stringstream ss;
1786 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1787 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1788 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1789 "%s", ss.str().c_str());
1790 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001791 if (pRegions[i].srcSubresource.layerCount == 0) {
1792 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1793 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltoneba86e22017-03-02 14:56:23 -07001794 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1795 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001796 }
1797 if (pRegions[i].dstSubresource.layerCount == 0) {
1798 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1799 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltoneba86e22017-03-02 14:56:23 -07001800 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1801 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001802 }
1803
1804 // Check that src/dst layercounts match
1805 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1806 skip |=
1807 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1808 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1809 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1810 i, validation_error_map[VALIDATION_ERROR_01304]);
1811 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001812
1813 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1814 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1815 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1816 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1817 validation_error_map[VALIDATION_ERROR_01303]);
1818 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001819 }
1820
1821 VkFormat src_format = src_image_state->createInfo.format;
1822 VkFormat dst_format = dst_image_state->createInfo.format;
1823
1824 // Validate consistency for unsigned formats
1825 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1826 std::stringstream ss;
1827 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1828 << "the other one must also have unsigned integer format. "
1829 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1830 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1831 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1832 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1833 }
1834
1835 // Validate consistency for signed formats
1836 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1837 std::stringstream ss;
1838 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1839 << "the other one must also have signed integer format. "
1840 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1841 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1842 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1843 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1844 }
1845
1846 // Validate aspect bits and formats for depth/stencil images
1847 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
1848 if (src_format != dst_format) {
1849 std::stringstream ss;
1850 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1851 << "stencil, the other one must have exactly the same format. "
1852 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1853 << string_VkFormat(dst_format);
1854 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1855 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1856 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1857 }
1858
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001859 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001860 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001861
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001862 if (vk_format_is_depth_and_stencil(src_format)) {
1863 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1864 std::stringstream ss;
1865 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1866 "VK_IMAGE_ASPECT_DEPTH_BIT "
1867 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1868 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1869 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1870 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1871 }
1872 } else if (vk_format_is_stencil_only(src_format)) {
1873 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1874 std::stringstream ss;
1875 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1876 << "set in both the srcImage and dstImage";
1877 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1878 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1879 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1880 }
1881 } else if (vk_format_is_depth_only(src_format)) {
1882 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1883 std::stringstream ss;
1884 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1885 << "set in both the srcImage and dstImage";
1886 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1887 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1888 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1889 }
1890 }
1891 }
1892 }
1893
1894 // Validate filter
1895 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1896 std::stringstream ss;
1897 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1898 << "then filter must be VK_FILTER_NEAREST.";
1899 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1900 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1901 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1902 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001903 } else {
1904 assert(0);
1905 }
1906 return skip;
1907}
1908
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001909void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1910 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001911 // Update bindings between images and cmd buffer
1912 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1913 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1914
1915 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1916 cb_node->validate_functions.push_back(function);
1917 function = [=]() {
1918 SetImageMemoryValid(device_data, dst_image_state, true);
1919 return false;
1920 };
1921 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001922 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001923}
1924
Tony Barbourdf013b92017-01-25 12:53:48 -07001925// This validates that the initial layout specified in the command buffer for
1926// the IMAGE is the same
1927// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001928bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1929 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001930 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001931 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001932 for (auto cb_image_data : pCB->imageLayoutMap) {
1933 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001934
Jeremy Hayes55b6c292017-02-28 09:44:45 -07001935 if (FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001936 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1937 // TODO: Set memory invalid which is in mem_tracker currently
1938 } else if (imageLayout != cb_image_data.second.initialLayout) {
1939 if (cb_image_data.first.hasSubresource) {
Dave Houltoneba86e22017-03-02 14:56:23 -07001940 skip |= log_msg(
1941 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1942 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1943 "Cannot submit cmd buffer using image (0x%" PRIx64
1944 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1945 "with layout %s when first use is %s.",
1946 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
1947 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
1948 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001949 } else {
Dave Houltoneba86e22017-03-02 14:56:23 -07001950 skip |=
1951 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1952 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1953 "Cannot submit cmd buffer using image (0x%" PRIx64
1954 ") with layout %s when "
1955 "first use is %s.",
1956 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), string_VkImageLayout(imageLayout),
1957 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001958 }
1959 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001960 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001961 }
1962 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001963 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001964}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001965
Tony Barbourdf013b92017-01-25 12:53:48 -07001966void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1967 for (auto cb_image_data : pCB->imageLayoutMap) {
1968 VkImageLayout imageLayout;
1969 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1970 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1971 }
1972}
1973
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001974// Print readable FlagBits in FlagMask
1975static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1976 std::string result;
1977 std::string separator;
1978
1979 if (accessMask == 0) {
1980 result = "[None]";
1981 } else {
1982 result = "[";
1983 for (auto i = 0; i < 32; i++) {
1984 if (accessMask & (1 << i)) {
1985 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1986 separator = " | ";
1987 }
1988 }
1989 result = result + "]";
1990 }
1991 return result;
1992}
1993
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001994// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1995// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001996// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001997static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
1998 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
1999 const char *type) {
2000 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2001 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002002
2003 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2004 if (accessMask & ~(required_bit | optional_bits)) {
2005 // TODO: Verify against Valid Use
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002006 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2007 DRAWSTATE_INVALID_BARRIER, "DS",
2008 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2009 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002010 }
2011 } else {
2012 if (!required_bit) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002013 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2014 DRAWSTATE_INVALID_BARRIER, "DS",
2015 "%s AccessMask %d %s must contain at least one of access bits %d "
2016 "%s when layout is %s, unless the app has previously added a "
2017 "barrier for this transition.",
2018 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2019 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002020 } else {
2021 std::string opt_bits;
2022 if (optional_bits != 0) {
2023 std::stringstream ss;
2024 ss << optional_bits;
2025 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2026 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002027 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2028 DRAWSTATE_INVALID_BARRIER, "DS",
2029 "%s AccessMask %d %s must have required access bit %d %s %s when "
2030 "layout is %s, unless the app has previously added a barrier for "
2031 "this transition.",
2032 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2033 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002034 }
2035 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002036 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002037}
2038
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002039bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
2040 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
2041 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002042
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002043 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002044 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002045 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
2046 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
2047 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2048 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002049 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002050 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
2051 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
2052 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2053 break;
2054 }
2055 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
2056 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
2057 break;
2058 }
2059 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
2060 skip |= ValidateMaskBits(
2061 device_data, cmdBuffer, accessMask, layout, 0,
2062 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
2063 type);
2064 break;
2065 }
2066 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
2067 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
2068 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
2069 break;
2070 }
2071 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
2072 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
2073 break;
2074 }
2075 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
2076 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
2077 break;
2078 }
2079 case VK_IMAGE_LAYOUT_UNDEFINED: {
2080 if (accessMask != 0) {
2081 // TODO: Verify against Valid Use section spec
2082 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2083 DRAWSTATE_INVALID_BARRIER, "DS",
2084 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2085 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
2086 }
2087 break;
2088 }
2089 case VK_IMAGE_LAYOUT_GENERAL:
2090 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002091 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002092 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002093}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002094
2095// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002096// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2097// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002098bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002099 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2100 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002101 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2102 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2103 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2104 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002105 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
2106 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
2107 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
2108 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002109 }
2110 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002111 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002112}
2113
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002114bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2115 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002116 bool skip = false;
2117
2118 // Track when we're observing the first use of an attachment
2119 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2120 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2121 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
2122 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2123 auto attach_index = subpass.pColorAttachments[j].attachment;
2124 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2125
2126 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002127 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
2128 // This is ideal.
2129 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002130
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002131 case VK_IMAGE_LAYOUT_GENERAL:
2132 // May not be optimal; TODO: reconsider this warning based on other constraints?
2133 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2134 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2135 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2136 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002137
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002138 default:
2139 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2140 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2141 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2142 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002143 }
2144
2145 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002146 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2147 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002148 }
2149 attach_first_use[attach_index] = false;
2150 }
2151 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2152 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002153 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2154 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2155 // These are ideal.
2156 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002157
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002158 case VK_IMAGE_LAYOUT_GENERAL:
2159 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2160 // doing a bunch of transitions.
2161 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2162 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2163 "GENERAL layout for depth attachment may not give optimal performance.");
2164 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002165
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002166 default:
2167 // No other layouts are acceptable
2168 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2169 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2170 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2171 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2172 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002173 }
2174
2175 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2176 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002177 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2178 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002179 }
2180 attach_first_use[attach_index] = false;
2181 }
2182 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2183 auto attach_index = subpass.pInputAttachments[j].attachment;
2184 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2185
2186 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002187 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2188 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2189 // These are ideal.
2190 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002191
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002192 case VK_IMAGE_LAYOUT_GENERAL:
2193 // May not be optimal. TODO: reconsider this warning based on other constraints.
2194 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2195 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2196 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2197 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002198
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002199 default:
2200 // No other layouts are acceptable
2201 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2202 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2203 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2204 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002205 }
2206
2207 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002208 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2209 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002210 }
2211 attach_first_use[attach_index] = false;
2212 }
2213 }
2214 return skip;
2215}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002216
2217// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002218bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2219 VkDeviceSize offset, VkDeviceSize end_offset) {
2220 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2221 bool skip = false;
2222 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2223 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002224 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2225 for (auto image_handle : mem_info->bound_images) {
2226 auto img_it = mem_info->bound_ranges.find(image_handle);
2227 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002228 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002229 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002230 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002231 for (auto layout : layouts) {
2232 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Dave Houltoneba86e22017-03-02 14:56:23 -07002233 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
2234 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Michael Lentinec174b932017-02-10 14:57:15 -06002235 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2236 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002237 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002238 }
2239 }
2240 }
2241 }
2242 }
2243 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002244 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002245}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002246
2247// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2248// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002249static 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 -07002250 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2251 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002252 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002253
2254 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002255 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002256 if (strict) {
2257 correct_usage = ((actual & desired) == desired);
2258 } else {
2259 correct_usage = ((actual & desired) != 0);
2260 }
2261 if (!correct_usage) {
2262 if (msgCode == -1) {
2263 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltoneba86e22017-03-02 14:56:23 -07002264 skip = log_msg(
2265 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2266 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation.",
2267 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002268 } else {
2269 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002270 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2271 "Invalid usage flag for %s 0x%" PRIxLEAST64
2272 " used by %s. In this case, %s should have %s set during creation. %s",
2273 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002274 }
2275 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002276 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002277}
2278
2279// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2280// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002281bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002282 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002283 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002284 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2285 msgCode, "image", func_name, usage_string);
2286}
2287
2288// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2289// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002290bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002291 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002292 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002293 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2294 msgCode, "buffer", func_name, usage_string);
2295}
2296
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002297bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002298 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002299 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2300
Mark Lobodzinski96210742017-02-09 10:33:46 -07002301 // TODO: Add check for VALIDATION_ERROR_00658
Mark Lobodzinski96210742017-02-09 10:33:46 -07002302 // TODO: Add check for VALIDATION_ERROR_00667
2303 // TODO: Add check for VALIDATION_ERROR_00668
2304 // TODO: Add check for VALIDATION_ERROR_00669
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002305
2306 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
2307 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2308 VALIDATION_ERROR_00666, "DS",
2309 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
2310 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
2311 validation_error_map[VALIDATION_ERROR_00666]);
2312 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06002313
2314 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
2315 skip |=
2316 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2317 DRAWSTATE_INVALID_FEATURE, "DS",
2318 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
2319 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
2320 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06002321
2322 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
2323 skip |=
2324 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2325 DRAWSTATE_INVALID_FEATURE, "DS",
2326 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
2327 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
2328 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07002329 return skip;
2330}
2331
2332void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2333 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2334 GetBufferMap(device_data)
2335 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2336}
2337
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002338bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2339 bool skip = false;
2340 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002341 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2342 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002343 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002344 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2345 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002346 skip |= ValidateBufferUsageFlags(
2347 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 -07002348 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2349 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002350 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002351}
2352
2353void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2354 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2355}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002356
2357// For the given format verify that the aspect masks make sense
2358bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2359 const char *func_name) {
2360 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2361 bool skip = false;
2362 if (vk_format_is_color(format)) {
2363 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2364 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2365 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2366 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2367 validation_error_map[VALIDATION_ERROR_00741]);
2368 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2369 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2370 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2371 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2372 validation_error_map[VALIDATION_ERROR_00741]);
2373 }
2374 } else if (vk_format_is_depth_and_stencil(format)) {
2375 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2377 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2378 "%s: Depth/stencil image formats must have "
2379 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2380 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2381 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2382 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
2383 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2384 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2385 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2386 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2387 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2388 }
2389 } else if (vk_format_is_depth_only(format)) {
2390 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2391 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2392 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2393 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2394 validation_error_map[VALIDATION_ERROR_00741]);
2395 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2396 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2397 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2398 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2399 validation_error_map[VALIDATION_ERROR_00741]);
2400 }
2401 } else if (vk_format_is_stencil_only(format)) {
2402 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2403 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2404 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2405 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2406 validation_error_map[VALIDATION_ERROR_00741]);
2407 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2408 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2409 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2410 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2411 validation_error_map[VALIDATION_ERROR_00741]);
2412 }
2413 }
2414 return skip;
2415}
2416
2417bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2418 const char *func_name) {
2419 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2420 bool skip = false;
2421 if (subresourceRange.levelCount == 0) {
2422 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2423 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2424 validation_error_map[VALIDATION_ERROR_00768]);
2425 }
2426 if (subresourceRange.layerCount == 0) {
2427 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2428 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2429 validation_error_map[VALIDATION_ERROR_00769]);
2430 }
2431 return skip;
2432}
2433
2434bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2435 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2436 bool skip = false;
2437 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2438 if (image_state) {
2439 skip |= ValidateImageUsageFlags(
2440 device_data, image_state,
2441 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2442 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2443 false, -1, "vkCreateImageView()",
2444 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2445 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2446 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2447 // Checks imported from image layer
2448 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2449 std::stringstream ss;
2450 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2451 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2452 skip |=
2453 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2454 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2455 }
2456 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2457 std::stringstream ss;
2458 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2459 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2460 skip |=
2461 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2462 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2463 }
2464 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2465 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2466
2467 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2468 VkFormat image_format = image_state->createInfo.format;
2469 VkFormat view_format = create_info->format;
2470 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2471
2472 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2473 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2474 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2475 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2476 std::stringstream ss;
2477 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2478 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2479 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2480 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
2481 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2482 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2483 validation_error_map[VALIDATION_ERROR_02171]);
2484 }
2485 } else {
2486 // Format MUST be IDENTICAL to the format the image was created with
2487 if (image_format != view_format) {
2488 std::stringstream ss;
2489 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2490 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2491 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
2492 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
2493 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2494 validation_error_map[VALIDATION_ERROR_02172]);
2495 }
2496 }
2497
2498 // Validate correct image aspect bits for desired formats and format consistency
2499 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2500 }
2501 return skip;
2502}
2503
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002504void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2505 auto image_view_map = GetImageViewMap(device_data);
2506 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2507
2508 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002509 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002510 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002511}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002512
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002513bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2514 BUFFER_STATE *dst_buffer_state) {
2515 bool skip = false;
2516 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2517 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2518 // Validate that SRC & DST buffers have correct usage flags set
2519 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2520 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2521 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2522 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2523 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2524 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2525 return skip;
2526}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002527
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002528void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2529 BUFFER_STATE *dst_buffer_state) {
2530 // Update bindings between buffers and cmd buffer
2531 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2532 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2533
2534 std::function<bool()> function = [=]() {
2535 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2536 };
2537 cb_node->validate_functions.push_back(function);
2538 function = [=]() {
2539 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2540 return false;
2541 };
2542 cb_node->validate_functions.push_back(function);
2543 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2544}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002545
2546static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2547 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2548 bool skip = false;
2549 auto buffer_state = GetBufferState(device_data, buffer);
2550 if (!buffer_state) {
2551 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2552 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2553 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2554 } else {
2555 if (buffer_state->in_use.load()) {
2556 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2557 __LINE__, VALIDATION_ERROR_00676, "DS",
2558 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2559 validation_error_map[VALIDATION_ERROR_00676]);
2560 }
2561 }
2562 return skip;
2563}
2564
2565bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2566 VK_OBJECT *obj_struct) {
2567 *image_view_state = GetImageViewState(device_data, image_view);
2568 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2569 if (GetDisables(device_data)->destroy_image_view) return false;
2570 bool skip = false;
2571 if (*image_view_state) {
2572 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2573 }
2574 return skip;
2575}
2576
2577void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2578 VK_OBJECT obj_struct) {
2579 // Any bound cmd buffers are now invalid
2580 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2581 (*GetImageViewMap(device_data)).erase(image_view);
2582}
2583
2584bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2585 *buffer_state = GetBufferState(device_data, buffer);
2586 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2587 if (GetDisables(device_data)->destroy_buffer) return false;
2588 bool skip = false;
2589 if (*buffer_state) {
2590 skip |= validateIdleBuffer(device_data, buffer);
2591 }
2592 return skip;
2593}
2594
2595void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2596 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2597 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2598 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2599 if (mem_info) {
2600 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2601 }
2602 }
2603 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2604 GetBufferMap(device_data)->erase(buffer_state->buffer);
2605}
2606
2607bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2608 VK_OBJECT *obj_struct) {
2609 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2610 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2611 if (GetDisables(device_data)->destroy_buffer_view) return false;
2612 bool skip = false;
2613 if (*buffer_view_state) {
2614 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2615 }
2616 return skip;
2617}
2618
2619void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2620 VK_OBJECT obj_struct) {
2621 // Any bound cmd buffers are now invalid
2622 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2623 GetBufferViewMap(device_data)->erase(buffer_view);
2624}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002625
2626bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2627 bool skip = false;
2628 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
2629 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2630 // Validate that DST buffer has correct usage flags set
2631 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2632 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2633 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2634 return skip;
2635}
2636
2637void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2638 std::function<bool()> function = [=]() {
2639 SetBufferMemoryValid(device_data, buffer_state, true);
2640 return false;
2641 };
2642 cb_node->validate_functions.push_back(function);
2643 // Update bindings between buffer and cmd buffer
2644 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2645 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2646}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002647
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002648bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2649 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002650 bool skip = false;
2651
2652 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002653 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
2654 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002655 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 -07002656 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
2657 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2658 "must be 0 and 1, respectively. %s",
2659 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2660 validation_error_map[VALIDATION_ERROR_01746]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002661 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002662 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002663
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002664 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
2665 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002666 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 -07002667 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
2668 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2669 "must be 0 and 1, respectively. %s",
2670 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2671 validation_error_map[VALIDATION_ERROR_01747]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002672 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002673 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002674
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002675 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2676 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2677 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2678 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
2679 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2680 "%d. For 3D images these must be 0 and 1, respectively. %s",
2681 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
2682 validation_error_map[VALIDATION_ERROR_01281]);
2683 }
2684 }
2685
2686 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2687 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
2688 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2689 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
2690 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2691 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2692 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
2693 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2694 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2695 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2696 }
2697
2698 // BufferOffset must be a multiple of 4
2699 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2700 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2701 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
2702 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2703 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2704 }
2705
2706 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2707 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2708 skip |= log_msg(
2709 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2710 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
2711 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2712 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2713 validation_error_map[VALIDATION_ERROR_01265]);
2714 }
2715
2716 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2717 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2718 skip |= log_msg(
2719 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2720 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
2721 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2722 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2723 validation_error_map[VALIDATION_ERROR_01266]);
2724 }
2725
2726 // subresource aspectMask must have exactly 1 bit set
2727 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2728 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2729 if (aspect_mask_bits.count() != 1) {
2730 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2731 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
2732 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2733 validation_error_map[VALIDATION_ERROR_01280]);
2734 }
2735
2736 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002737 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002738 skip |= log_msg(
2739 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2740 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
2741 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
2742 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
2743 validation_error_map[VALIDATION_ERROR_01279]);
2744 }
2745
2746 // Checks that apply only to compressed images
2747 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2748 // reserves a place for these compressed image checks. This block of code could move there once the image
2749 // stuff is moved into core validation.
2750 if (vk_format_is_compressed(image_state->createInfo.format)) {
2751 auto block_size = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2752
2753 // BufferRowLength must be a multiple of block width
2754 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002755 skip |= log_msg(
2756 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002757 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
2758 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2759 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002760 }
2761
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002762 // BufferRowHeight must be a multiple of block height
2763 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002764 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 -07002765 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
2766 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2767 "height (%d). %s.",
2768 function, i, pRegions[i].bufferImageHeight, block_size.height,
2769 validation_error_map[VALIDATION_ERROR_01272]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002770 }
2771
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002772 // image offsets must be multiples of block dimensions
2773 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
Dave Houlton75967fc2017-03-06 17:21:16 -07002774 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
2775 (vk_safe_modulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002776 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2777 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
2778 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2779 "width & height (%d, %d). %s.",
2780 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2781 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002782 }
2783
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002784 // bufferOffset must be a multiple of block size (linear bytes)
2785 size_t block_size_in_bytes = vk_format_get_size(image_state->createInfo.format);
2786 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
2787 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2788 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01274, "IMAGE",
2789 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
2790 ") must be a multiple of the compressed image's texel block "
2791 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
2792 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2793 validation_error_map[VALIDATION_ERROR_01274]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002794 }
Dave Houlton67e9b532017-03-02 17:00:10 -07002795
2796 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07002797 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton67e9b532017-03-02 17:00:10 -07002798 if ((vk_safe_modulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002799 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
2800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2801 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01275, "IMAGE",
2802 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
2803 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
2804 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
2805 mip_extent.width, validation_error_map[VALIDATION_ERROR_01275]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002806 }
2807
2808 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
2809 if ((vk_safe_modulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002810 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
2811 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2812 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01276, "IMAGE",
2813 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
2814 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
2815 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
2816 mip_extent.height, validation_error_map[VALIDATION_ERROR_01276]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002817 }
2818
2819 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
2820 if ((vk_safe_modulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002821 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
2822 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2823 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01277, "IMAGE",
2824 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
2825 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
2826 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
2827 mip_extent.depth, validation_error_map[VALIDATION_ERROR_01277]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002828 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002829 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002830 }
2831
2832 return skip;
2833}
2834
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002835static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
2836 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002837 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002838 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002839
2840 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002841 VkExtent3D extent = pRegions[i].imageExtent;
2842 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002843
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002844 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
2845 {
2846 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2847 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
2848 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
2849 extent.height, extent.depth);
2850 }
2851
2852 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
2853
2854 // 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 -07002855 if (vk_format_is_compressed(image_info->format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002856 auto block_extent = vk_format_compressed_texel_block_extents(image_info->format);
2857 if (image_extent.width % block_extent.width) {
2858 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
2859 }
2860 if (image_extent.height % block_extent.height) {
2861 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
2862 }
2863 if (image_extent.depth % block_extent.depth) {
2864 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
2865 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002866 }
2867
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002868 if (ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002869 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 -07002870 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002871 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002872 }
2873 }
2874
2875 return skip;
2876}
2877
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002878static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2879 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2880 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2881 bool skip = false;
2882
2883 VkDeviceSize buffer_size = buff_state->createInfo.size;
2884
2885 for (uint32_t i = 0; i < regionCount; i++) {
2886 VkExtent3D copy_extent = pRegions[i].imageExtent;
2887
2888 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2889 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2890 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2891
Dave Houltonf3229d52017-02-21 15:59:08 -07002892 // Handle special buffer packing rules for specific depth/stencil formats
2893 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2894 unit_size = vk_format_get_size(VK_FORMAT_S8_UINT);
2895 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2896 switch (image_state->createInfo.format) {
2897 case VK_FORMAT_D16_UNORM_S8_UINT:
2898 unit_size = vk_format_get_size(VK_FORMAT_D16_UNORM);
2899 break;
2900 case VK_FORMAT_D32_SFLOAT_S8_UINT:
2901 unit_size = vk_format_get_size(VK_FORMAT_D32_SFLOAT);
2902 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002903 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07002904 case VK_FORMAT_D24_UNORM_S8_UINT:
2905 unit_size = 4;
2906 break;
2907 default:
2908 break;
2909 }
2910 }
2911
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002912 if (vk_format_is_compressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002913 // Switch to texel block units, rounding up for any partially-used blocks
2914 auto block_dim = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2915 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
2916 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
2917
2918 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
2919 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
2920 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002921 }
2922
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002923 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
2924 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2925 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
2926 // TODO: Issure warning here? Already warned in ValidateImageBounds()...
2927 } else {
2928 // Calculate buffer offset of final copied byte, + 1.
2929 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
2930 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2931 max_buffer_offset *= unit_size; // convert to bytes
2932 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002933
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002934 if (buffer_size < max_buffer_offset) {
2935 skip |=
2936 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2937 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
2938 i, buffer_size, validation_error_map[msg_code]);
2939 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002940 }
2941 }
2942
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002943 return skip;
2944}
2945
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002946bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002947 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002948 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002949 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2950 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2951
2952 // Validate command buffer state
2953 if (CB_RECORDING != cb_node->state) {
2954 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2955 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2956 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2957 validation_error_map[VALIDATION_ERROR_01258]);
2958 } else {
2959 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2960 }
2961
2962 // Command pool must support graphics, compute, or transfer operations
2963 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2964
2965 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2966 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2968 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2969 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2970 "or transfer capabilities. %s.",
2971 validation_error_map[VALIDATION_ERROR_01259]);
2972 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002973 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002974 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002975 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002976 VALIDATION_ERROR_01246);
2977
2978 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2979 VALIDATION_ERROR_01249);
2980 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002981 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002982
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002983 // Validate that SRC image & DST buffer have correct usage flags set
2984 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2985 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002986 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002987 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002988 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
2989 for (uint32_t i = 0; i < regionCount; ++i) {
2990 skip |= VerifySourceImageLayout(device_data, cb_node, src_image_state->image, pRegions[i].imageSubresource, srcImageLayout,
2991 VALIDATION_ERROR_01251);
2992 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
2993 "CmdCopyImageToBuffer");
2994 }
2995 return skip;
2996}
2997
2998void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002999 BUFFER_STATE *dst_buffer_state) {
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003000 // Update bindings between buffer/image and cmd buffer
3001 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003002 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003003
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003004 std::function<bool()> function = [=]() {
3005 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
3006 };
3007 cb_node->validate_functions.push_back(function);
3008 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003009 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003010 return false;
3011 };
3012 cb_node->validate_functions.push_back(function);
3013
3014 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003015}
3016
3017bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003018 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003019 const VkBufferImageCopy *pRegions, const char *func_name) {
3020 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3021 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
3022
3023 // Validate command buffer state
3024 if (CB_RECORDING != cb_node->state) {
3025 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3026 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
3027 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
3028 validation_error_map[VALIDATION_ERROR_01240]);
3029 } else {
3030 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
3031 }
3032
3033 // Command pool must support graphics, compute, or transfer operations
3034 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3035 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3036 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3037 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3038 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
3039 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
3040 "or transfer capabilities. %s.",
3041 validation_error_map[VALIDATION_ERROR_01241]);
3042 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003043 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003044 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003045 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003046 VALIDATION_ERROR_01227);
3047 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
3048 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003049 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003050 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003051 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003052 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3053 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
3054 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003055 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
3056 for (uint32_t i = 0; i < regionCount; ++i) {
3057 skip |= VerifyDestImageLayout(device_data, cb_node, dst_image_state->image, pRegions[i].imageSubresource, dstImageLayout,
3058 VALIDATION_ERROR_01234);
3059 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
3060 "vkCmdCopyBufferToImage()");
3061 }
3062 return skip;
3063}
3064
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003065void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003066 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003067 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003068 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003069 std::function<bool()> function = [=]() {
3070 SetImageMemoryValid(device_data, dst_image_state, true);
3071 return false;
3072 };
3073 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003074 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003075 cb_node->validate_functions.push_back(function);
3076
3077 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003078}
Mike Weiblen672b58b2017-02-21 14:32:53 -07003079
3080bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
3081 const auto report_data = core_validation::GetReportData(device_data);
3082 bool skip = false;
3083 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
3084
3085 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
3086 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
3087 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
3088 if (aspect_mask_bits.count() != 1) {
3089 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
3090 VALIDATION_ERROR_00733, "IMAGE",
3091 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
3092 validation_error_map[VALIDATION_ERROR_00733]);
3093 }
3094
3095 IMAGE_STATE *image_entry = GetImageState(device_data, image);
3096 if (!image_entry) {
3097 return skip;
3098 }
3099
3100 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
3101 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
3102 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3103 __LINE__, VALIDATION_ERROR_00732, "IMAGE",
3104 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
3105 validation_error_map[VALIDATION_ERROR_00732]);
3106 }
3107
3108 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
3109 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
3110 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3111 __LINE__, VALIDATION_ERROR_00739, "IMAGE",
3112 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
3113 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
3114 }
3115
3116 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
3117 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
3118 skip |= log_msg(
3119 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
3120 VALIDATION_ERROR_00740, "IMAGE", "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
3121 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
3122 }
3123
3124 // VU 00741: subresource's aspect must be compatible with image's format.
3125 const VkFormat img_format = image_entry->createInfo.format;
3126 if (vk_format_is_color(img_format)) {
3127 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
3128 skip |= log_msg(
3129 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image, __LINE__,
3130 VALIDATION_ERROR_00741, "IMAGE",
3131 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
3132 validation_error_map[VALIDATION_ERROR_00741]);
3133 }
3134 } else if (vk_format_is_depth_or_stencil(img_format)) {
3135 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
3136 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
3137 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
3138 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
3139 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
3140 validation_error_map[VALIDATION_ERROR_00741]);
3141 }
3142 }
3143 return skip;
3144}