blob: b5705b427f270235b06f742d3fcc6e1cb85e6b9b [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}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600231// Set image layout for given VkImageSubresourceRange struct
232void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
233 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
234 assert(image_state);
235 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
236 uint32_t level = image_subresource_range.baseMipLevel + level_index;
237 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
238 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
239 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700240 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
241 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600242 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
243 if (vk_format_is_depth_and_stencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700244 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
245 }
246 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600247 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700248 }
249 }
250}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600251// Set image layout for given VkImageSubresourceLayers struct
252void SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
253 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
254 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
255 VkImageSubresourceRange image_subresource_range;
256 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
257 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
258 image_subresource_range.layerCount = image_subresource_layers.layerCount;
259 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
260 image_subresource_range.levelCount = 1;
261 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
262}
263// Set image layout for all slices of an image view
264void SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
265 auto view_state = GetImageViewState(device_data, imageView);
266 assert(view_state);
267
268 SetImageLayout(device_data, cb_node, GetImageState(device_data, view_state->create_info.image),
269 view_state->create_info.subresourceRange, layout);
270}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700271
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700272bool VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700273 const VkRenderPassBeginInfo *pRenderPassBegin,
274 const FRAMEBUFFER_STATE *framebuffer_state) {
275 bool skip_call = false;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700276 auto const pRenderPassInfo = GetRenderPassState(device_data, pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700277 auto const &framebufferInfo = framebuffer_state->createInfo;
278 const auto report_data = core_validation::GetReportData(device_data);
279 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600280 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
281 reinterpret_cast<uint64_t>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700282 "You cannot start a render pass using a framebuffer "
283 "with a different number of attachments.");
284 }
285 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
286 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700287 auto view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700288 assert(view_state);
289 const VkImage &image = view_state->create_info.image;
290 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
291 IMAGE_CMD_BUF_LAYOUT_NODE newNode = {pRenderPassInfo->pAttachments[i].initialLayout,
292 pRenderPassInfo->pAttachments[i].initialLayout};
293 // TODO: Do not iterate over every possibility - consolidate where possible
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700294 // TODO: Consolidate this with SetImageViewLayout() function above
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700295 for (uint32_t j = 0; j < subRange.levelCount; j++) {
296 uint32_t level = subRange.baseMipLevel + j;
297 for (uint32_t k = 0; k < subRange.layerCount; k++) {
298 uint32_t layer = subRange.baseArrayLayer + k;
299 VkImageSubresource sub = {subRange.aspectMask, level, layer};
300 IMAGE_CMD_BUF_LAYOUT_NODE node;
301 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis2b716cb2017-02-16 13:21:20 -0700302 // If ImageView was created with depth or stencil, transition both aspects if it's a DS image
303 if (subRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
304 if (vk_format_is_depth_and_stencil(view_state->create_info.format)) {
305 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
306 }
307 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700308 SetLayout(device_data, pCB, image, sub, newNode);
309 continue;
310 }
311 if (newNode.layout != VK_IMAGE_LAYOUT_UNDEFINED && newNode.layout != node.layout) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600312 skip_call |=
313 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
314 reinterpret_cast<uint64_t>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_RENDERPASS, "DS",
315 "You cannot start a render pass using attachment %u "
316 "where the render pass initial layout is %s and the previous "
317 "known layout of the attachment is %s. The layouts must match, or "
318 "the render pass initial layout for the attachment must be "
319 "VK_IMAGE_LAYOUT_UNDEFINED",
320 i, string_VkImageLayout(newNode.layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700321 }
322 }
323 }
324 }
325 return skip_call;
326}
327
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700328void TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700329 VkAttachmentReference ref) {
330 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
331 auto image_view = pFramebuffer->createInfo.pAttachments[ref.attachment];
332 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
333 }
334}
335
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700336void TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
337 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700338 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700339 if (!renderPass) return;
340
341 if (framebuffer_state) {
342 auto const &subpass = renderPass->createInfo.pSubpasses[subpass_index];
343 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
344 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
345 }
346 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
347 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
348 }
349 if (subpass.pDepthStencilAttachment) {
350 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
351 }
352 }
353}
354
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700355bool ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
356 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700357 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
358 return false;
359 }
360 VkImageSubresource sub = {aspect, level, layer};
361 IMAGE_CMD_BUF_LAYOUT_NODE node;
362 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700363 return false;
364 }
365 bool skip = false;
366 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
367 // TODO: Set memory invalid which is in mem_tracker currently
368 } else if (node.layout != mem_barrier->oldLayout) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600369 skip |= log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
370 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(pCB->commandBuffer), __LINE__,
371 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700372 "You cannot transition the layout of aspect %d from %s when current layout is %s.", aspect,
373 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
374 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700375 return skip;
376}
377
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700378void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
379 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
380 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
381 return;
382 }
383 VkImageSubresource sub = {aspect, level, layer};
384 IMAGE_CMD_BUF_LAYOUT_NODE node;
385 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
386 SetLayout(device_data, pCB, mem_barrier->image, sub,
387 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
388 return;
389 }
390 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
391 // TODO: Set memory invalid
392 }
393 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
394}
395
Dave Houlton10b39482017-03-16 13:18:15 -0600396bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600397 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
398 if (!vk_format_is_color(format)) return false;
399 }
400 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
401 if (!vk_format_has_depth(format)) return false;
402 }
403 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
404 if (!vk_format_has_stencil(format)) return false;
405 }
406 return true;
407}
408
Mike Weiblen62d08a32017-03-07 22:18:27 -0700409// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
410bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
411 VkImageUsageFlags usage_flags, const char *func_name) {
412 const auto report_data = core_validation::GetReportData(device_data);
413 bool skip = false;
414 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
415 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
416
417 switch (layout) {
418 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
419 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
420 msg_code = VALIDATION_ERROR_00303;
421 }
422 break;
423 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
424 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
425 msg_code = VALIDATION_ERROR_00304;
426 }
427 break;
428 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
429 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
430 msg_code = VALIDATION_ERROR_00305;
431 }
432 break;
433 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
434 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
435 msg_code = VALIDATION_ERROR_00306;
436 }
437 break;
438 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
439 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
440 msg_code = VALIDATION_ERROR_00307;
441 }
442 break;
443 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
444 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
445 msg_code = VALIDATION_ERROR_00308;
446 }
447 break;
448 default:
449 // Other VkImageLayout values do not have VUs defined in this context.
450 break;
451 }
452
453 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600454 skip |=
455 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
456 reinterpret_cast<const uint64_t &>(img_barrier->image), __LINE__, msg_code, "DS",
457 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ". %s",
458 func_name, img_barrier, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
459 reinterpret_cast<const uint64_t &>(img_barrier->image), usage_flags, validation_error_map[msg_code]);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700460 }
461 return skip;
462}
463
464// Verify image barriers are compatible with the images they reference.
465bool ValidateBarriersToImages(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t imageMemoryBarrierCount,
466 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700467 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700468 bool skip = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700469 uint32_t level_count = 0;
470 uint32_t layer_count = 0;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700471
Mike Weiblen62d08a32017-03-07 22:18:27 -0700472 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
473 auto img_barrier = &pImageMemoryBarriers[i];
474 if (!img_barrier) continue;
475
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700476 // TODO: Do not iterate over every possibility - consolidate where possible
Mike Weiblen62d08a32017-03-07 22:18:27 -0700477 ResolveRemainingLevelsLayers(device_data, &level_count, &layer_count, img_barrier->subresourceRange,
478 GetImageState(device_data, img_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700479
Mike Weiblen62d08a32017-03-07 22:18:27 -0700480 for (uint32_t j = 0; j < level_count; j++) {
481 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
482 for (uint32_t k = 0; k < layer_count; k++) {
483 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
484 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
485 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
486 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
487 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700488 }
489 }
Mike Weiblen62d08a32017-03-07 22:18:27 -0700490
491 IMAGE_STATE *image_state = GetImageState(device_data, img_barrier->image);
492 if (image_state) {
493 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
494 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
495 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
496 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700497 }
498 return skip;
499}
500
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700501void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
502 const VkImageMemoryBarrier *pImgMemBarriers) {
503 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
504 uint32_t levelCount = 0;
505 uint32_t layerCount = 0;
506
507 for (uint32_t i = 0; i < memBarrierCount; ++i) {
508 auto mem_barrier = &pImgMemBarriers[i];
509 if (!mem_barrier) continue;
510 // TODO: Do not iterate over every possibility - consolidate where possible
511 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
512 GetImageState(device_data, mem_barrier->image));
513
514 for (uint32_t j = 0; j < levelCount; j++) {
515 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
516 for (uint32_t k = 0; k < layerCount; k++) {
517 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
518 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
519 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
520 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
521 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
522 }
523 }
524 }
525}
526
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600527bool VerifyImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
528 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600529 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700530 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600531 const auto image = image_state->image;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700532 bool skip_call = false;
533
534 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
535 uint32_t layer = i + subLayers.baseArrayLayer;
536 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
537 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600538 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
539 if (node.layout != explicit_layout) {
540 // TODO: Improve log message in the next pass
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600541 skip_call |=
542 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
543 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
544 "%s: Cannot use an image with specific layout %s "
545 "that doesn't match the actual current layout %s.",
546 caller, string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600547 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700548 }
549 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600550 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
551 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
552 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700553 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
554 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600555 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
556 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
557 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT,
558 "DS", "%s: For optimal performance image layout should be %s instead of GENERAL.", caller,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600559 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700560 }
561 } else {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600562 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
563 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, msg_code, "DS",
564 "%s: Layout for image is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s", caller,
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600565 string_VkImageLayout(explicit_layout), string_VkImageLayout(optimal_layout),
566 validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567 }
568 }
569 return skip_call;
570}
571
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700572void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
573 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700574 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 if (!renderPass) return;
576
577 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
578 if (framebuffer_state) {
579 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
580 auto image_view = framebuffer_state->createInfo.pAttachments[i];
581 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
582 }
583 }
584}
585
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700586bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700587 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
588 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700589 const debug_report_data *report_data = core_validation::GetReportData(device_data);
590
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600591 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700592 skip_call |=
593 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
594 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
595 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600596
597 return skip_call;
598 }
599
600 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
601
602 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
603 std::stringstream ss;
604 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
605 skip_call |=
606 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
607 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
608
609 return skip_call;
610 }
611
612 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
613 std::stringstream ss;
614 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
615 skip_call |=
616 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
617 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
618
619 return skip_call;
620 }
621
622 // Validate that format supports usage as color attachment
623 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
624 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
625 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
626 std::stringstream ss;
627 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
628 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
629 skip_call |=
630 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
631 VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
632 }
633 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
634 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
635 std::stringstream ss;
636 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
637 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
638 skip_call |=
639 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
640 VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
641 }
642 }
643
644 // Validate that format supports usage as depth/stencil attachment
645 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
646 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
647 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
648 std::stringstream ss;
649 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
650 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
651 skip_call |=
652 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
653 VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
654 }
655 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
656 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
657 std::stringstream ss;
658 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
659 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
660 skip_call |=
661 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
662 VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
663 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700664 }
665
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700666 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
667 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700668
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700669 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700670 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
671
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700672 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
673 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
674 VALIDATION_ERROR_00716, "Image",
675 "CreateImage extent is 0 for at least one required dimension for image: "
676 "Width = %d Height = %d Depth = %d. %s",
677 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
678 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700679 }
680
681 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
682 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700683 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
684 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
685 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700686 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
687 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
688 "CreateImage extents exceed allowable limits for format: "
689 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
690 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700691 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
692 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700693 }
694
695 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
696 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
697 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
698 (uint64_t)imageGranularity) &
699 ~(uint64_t)imageGranularity;
700
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700701 if (totalSize > ImageFormatProperties->maxResourceSize) {
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 resource size exceeds allowable maximum "
705 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700706 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700707 }
708
709 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700710 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700711 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
712 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
713 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700714 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700715 }
716
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700717 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700718 skip_call |= log_msg(
719 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
720 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700721 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700722 }
723
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700724 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700725 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
726 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700727 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700728 validation_error_map[VALIDATION_ERROR_02138]);
729 }
730
731 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
732 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
733 VALIDATION_ERROR_00731, "Image",
734 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
735 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
736 validation_error_map[VALIDATION_ERROR_00731]);
737 }
738
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600739 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
740 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
741 VALIDATION_ERROR_02143, "DS",
742 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
743 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
744 validation_error_map[VALIDATION_ERROR_02143]);
745 }
746
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600747 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
748 skip_call |=
749 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
750 DRAWSTATE_INVALID_FEATURE, "DS",
751 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
752 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
753 }
754
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700755 return skip_call;
756}
757
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700758void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700759 IMAGE_LAYOUT_NODE image_state;
760 image_state.layout = pCreateInfo->initialLayout;
761 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700762 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 -0700763 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700764 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
765 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700766}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700767
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700768bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700769 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700770 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700771 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
772 if (disabled->destroy_image) return false;
773 bool skip = false;
774 if (*image_state) {
775 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
776 }
777 return skip;
778}
779
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700780void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700781 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
782 // Clean up memory mapping, bindings and range references for image
783 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700784 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700785 if (mem_info) {
786 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
787 }
788 }
789 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
790 // Remove image from imageMap
791 core_validation::GetImageMap(device_data)->erase(image);
792 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
793 core_validation::GetImageSubresourceMap(device_data);
794
795 const auto &sub_entry = imageSubresourceMap->find(image);
796 if (sub_entry != imageSubresourceMap->end()) {
797 for (const auto &pair : sub_entry->second) {
798 core_validation::GetImageLayoutMap(device_data)->erase(pair);
799 }
800 imageSubresourceMap->erase(sub_entry);
801 }
802}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700803
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700804bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700805 bool skip = false;
806 const debug_report_data *report_data = core_validation::GetReportData(device_data);
807
808 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
809 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
811 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
812 }
813
814 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
815 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
816 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
817 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
818 validation_error_map[VALIDATION_ERROR_01088]);
819 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
820 char const str[] = "vkCmdClearColorImage called with compressed image.";
821 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
822 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
823 validation_error_map[VALIDATION_ERROR_01088]);
824 }
825
826 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
827 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
829 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
830 validation_error_map[VALIDATION_ERROR_01084]);
831 }
832 return skip;
833}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700834
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700835void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700836 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
837 // internal state to the actual values.
838 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
839 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
840 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700841
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700842 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
843 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700844 }
845}
846
847// 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 -0700848void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
849 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700850 *levels = range.levelCount;
851 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700852 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
853 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
854 }
855 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
856 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700857 }
858}
859
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700860bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700861 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
862 bool skip = false;
863 const debug_report_data *report_data = core_validation::GetReportData(device_data);
864
865 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700866 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700867
868 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
869 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700870 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
871 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600872 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
873 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700874 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
875 }
876 } else {
877 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
878 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
879 error_code = VALIDATION_ERROR_01101;
880 } else {
881 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
882 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600883 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
884 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, error_code, "DS",
885 "%s: Layout for cleared image is %s but can only be "
886 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
887 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700888 }
889 }
890
891 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
892 uint32_t level = level_index + resolved_range.baseMipLevel;
893 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
894 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
895 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
896 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700897 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700898 if (node.layout != dest_image_layout) {
899 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
900 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
901 error_code = VALIDATION_ERROR_01100;
902 } else {
903 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
904 }
905 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
906 __LINE__, error_code, "DS",
907 "%s: Cannot clear an image whose layout is %s and "
908 "doesn't match the current layout %s. %s",
909 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
910 validation_error_map[error_code]);
911 }
912 }
913 }
914 }
915
916 return skip;
917}
918
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700919void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
920 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700921 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700922 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700923
924 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
925 uint32_t level = level_index + resolved_range.baseMipLevel;
926 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
927 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
928 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
929 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700930 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
931 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 -0700932 }
933 }
934 }
935}
936
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700937bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700938 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
939 bool skip = false;
940 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700941 auto cb_node = GetCBNode(dev_data, commandBuffer);
942 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700943 if (cb_node && image_state) {
944 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
945 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
946 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
947 for (uint32_t i = 0; i < rangeCount; ++i) {
948 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700949 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700950 }
951 }
952 return skip;
953}
954
955// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700956void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
957 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700958 auto cb_node = GetCBNode(dev_data, commandBuffer);
959 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700960 if (cb_node && image_state) {
961 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
962 std::function<bool()> function = [=]() {
963 SetImageMemoryValid(dev_data, image_state, true);
964 return false;
965 };
966 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700967 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700968 for (uint32_t i = 0; i < rangeCount; ++i) {
969 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
970 }
971 }
972}
973
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700974bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
975 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700976 const VkImageSubresourceRange *pRanges) {
977 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700978 const debug_report_data *report_data = core_validation::GetReportData(device_data);
979
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700980 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700981 auto cb_node = GetCBNode(device_data, commandBuffer);
982 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700983 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700984 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
985 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
986 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700987 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700988 skip |=
989 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700990 // Image aspect must be depth or stencil or both
991 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
992 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
993 char const str[] =
994 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
995 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
996 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
997 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
998 }
999 }
1000 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
1001 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
1002 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1003 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
1004 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001005 }
1006 }
1007 return skip;
1008}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001009
1010// Returns true if [x, xoffset] and [y, yoffset] overlap
1011static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1012 bool result = false;
1013 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1014 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1015
1016 if (intersection_max > intersection_min) {
1017 result = true;
1018 }
1019 return result;
1020}
1021
1022// Returns true if two VkImageCopy structures overlap
1023static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1024 bool result = false;
1025 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1026 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1027 dst->dstSubresource.layerCount))) {
1028 result = true;
1029 switch (type) {
1030 case VK_IMAGE_TYPE_3D:
1031 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1032 // Intentionally fall through to 2D case
1033 case VK_IMAGE_TYPE_2D:
1034 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1035 // Intentionally fall through to 1D case
1036 case VK_IMAGE_TYPE_1D:
1037 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1038 break;
1039 default:
1040 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1041 assert(false);
1042 }
1043 }
1044 return result;
1045}
1046
1047// Returns true if offset and extent exceed image extents
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001048static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001049 bool result = false;
1050 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001051 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1052 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
1053 result = true;
1054 }
1055 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1056 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
1057 result = true;
1058 }
1059 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1060 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
1061 result = true;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001062 }
1063 return result;
1064}
1065
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001066// Test if two VkExtent3D structs are equivalent
1067static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1068 bool result = true;
1069 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1070 (extent->depth != other_extent->depth)) {
1071 result = false;
1072 }
1073 return result;
1074}
1075
1076// Returns the image extent of a specific subresource.
1077static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1078 const uint32_t mip = subresource->mipLevel;
1079 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001080 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
1081 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1082 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1083 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001084 return extent;
1085}
1086
1087// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001088static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001089 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1090}
1091
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001092// Test if the extent argument has any dimensions set to 0.
1093static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1094 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1095}
1096
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001097// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1098static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1099 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1100 VkExtent3D granularity = {0, 0, 0};
1101 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1102 if (pPool) {
1103 granularity =
1104 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
1105 if (vk_format_is_compressed(img->createInfo.format)) {
Mark Lobodzinski13086442017-02-24 08:53:14 -07001106 auto block_size = vk_format_compressed_texel_block_extents(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001107 granularity.width *= block_size.width;
1108 granularity.height *= block_size.height;
1109 }
1110 }
1111 return granularity;
1112}
1113
1114// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1115static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1116 bool valid = true;
1117 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
1118 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
1119 valid = false;
1120 }
1121 return valid;
1122}
1123
1124// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1125static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1126 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1127 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1128 bool skip = false;
1129 VkExtent3D offset_extent = {};
1130 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1131 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1132 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001133 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001134 // 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 -07001135 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001136 skip |=
1137 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1138 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1139 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1140 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1141 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001142 }
1143 } else {
1144 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1145 // integer multiples of the image transfer granularity.
1146 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001147 skip |= log_msg(
1148 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1149 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1150 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1151 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1152 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height, granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001153 }
1154 }
1155 return skip;
1156}
1157
1158// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1159static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1160 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1161 const uint32_t i, const char *function, const char *member) {
1162 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1163 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001164 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001165 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1166 // subresource extent.
1167 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001168 skip |=
1169 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1170 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1171 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1172 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1173 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1174 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001175 }
1176 } else {
1177 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1178 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1179 // subresource extent dimensions.
1180 VkExtent3D offset_extent_sum = {};
1181 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1182 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1183 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1184 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1185 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001186 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1187 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001188 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1189 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1190 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1191 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1192 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1193 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1194 }
1195 }
1196 return skip;
1197}
1198
1199// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1200static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1201 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1202 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1203
1204 bool skip = false;
1205 if (vk_safe_modulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001206 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1207 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001208 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1209 "transfer granularity width (%d).",
1210 function, i, member, value, granularity);
1211 }
1212 return skip;
1213}
1214
1215// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1216static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1217 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1218 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1219 bool skip = false;
1220 if (vk_safe_modulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001221 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1222 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001223 "%s: pRegion[%d].%s (%" PRIdLEAST64
1224 ") must be an even integer multiple of this command buffer's queue family image transfer "
1225 "granularity width (%d).",
1226 function, i, member, value, granularity);
1227 }
1228 return skip;
1229}
1230
1231// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1232bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1233 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1234 const uint32_t i, const char *function) {
1235 bool skip = false;
1236 if (vk_format_is_compressed(img->createInfo.format) == true) {
1237 // TODO: Add granularity checking for compressed formats
1238
1239 // bufferRowLength must be a multiple of the compressed texel block width
1240 // bufferImageHeight must be a multiple of the compressed texel block height
1241 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1242 // bufferOffset must be a multiple of the compressed texel block size in bytes
1243 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1244 // must equal the image subresource width
1245 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1246 // must equal the image subresource height
1247 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1248 // must equal the image subresource depth
1249 } else {
1250 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1251 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1252 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1253 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1254 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1255 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1256 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1257 i, function, "imageExtent");
1258 }
1259 return skip;
1260}
1261
1262// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1263bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1264 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1265 const char *function) {
1266 bool skip = false;
1267 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1268 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1269 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1270 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1271 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1272 function, "extent");
1273 return skip;
1274}
1275
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001276bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001277 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1278 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001279 bool skip = false;
1280 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1281 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1282
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001283 for (uint32_t i = 0; i < region_count; i++) {
1284 if (regions[i].srcSubresource.layerCount == 0) {
1285 std::stringstream ss;
1286 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1287 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1288 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1289 ss.str().c_str());
1290 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001291
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001292 if (regions[i].dstSubresource.layerCount == 0) {
1293 std::stringstream ss;
1294 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1295 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1296 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1297 ss.str().c_str());
1298 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001299
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001300 // For each region the layerCount member of srcSubresource and dstSubresource must match
1301 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1302 std::stringstream ss;
1303 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1305 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1306 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1307 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001308
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001309 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1310 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1311 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1312 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1313 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1314 validation_error_map[VALIDATION_ERROR_01197]);
1315 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001316
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001317 // For each region, the aspectMask member of srcSubresource must be present in the source image
1318 if (!VerifyAspectsPresent(regions[i].srcSubresource.aspectMask, src_image_state->createInfo.format)) {
1319 std::stringstream ss;
1320 ss << "vkCmdCopyImage: pRegion[" << i
1321 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1322 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1323 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01200, "IMAGE", "%s. %s",
1324 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01200]);
1325 }
1326
1327 // For each region, the aspectMask member of dstSubresource must be present in the destination image
1328 if (!VerifyAspectsPresent(regions[i].dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
1329 std::stringstream ss;
1330 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1331 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1332 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01201, "IMAGE", "%s. %s",
1333 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01201]);
1334 }
1335
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001336 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1337 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1338 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1339 std::stringstream ss;
1340 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1341 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1342 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1343 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1344 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001345
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001346 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1347 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1348 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1349 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1350 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1351 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1352 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1353 validation_error_map[VALIDATION_ERROR_01221]);
1354 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001355
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001356 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1357 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1358 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1359 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1360 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1361 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1362 std::stringstream ss;
1363 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1364 << "] baseArrayLayer was not zero or layerCount was not 1.";
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_01199, "IMAGE", "%s. %s",
1367 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1368 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001369
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001370 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1371 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1372 std::stringstream ss;
1373 ss << "vkCmdCopyImage: pRegions[" << i
1374 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1375 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1376 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1377 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1378 }
1379 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1380 std::stringstream ss;
1381 ss << "vkCmdCopyImage: pRegions[" << i
1382 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1383 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1384 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1385 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1386 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001387
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001388 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1389 // image was created
1390 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1391 src_image_state->createInfo.arrayLayers) {
1392 std::stringstream ss;
1393 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1394 << "] baseArrayLayer + layerCount is "
1395 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1396 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1397 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1398 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1399 }
1400 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1401 dst_image_state->createInfo.arrayLayers) {
1402 std::stringstream ss;
1403 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1404 << "] baseArrayLayer + layerCount is "
1405 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1406 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1407 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1408 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1409 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001410
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001411 // 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 -07001412 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &(src_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001413 std::stringstream ss;
1414 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1415 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1416 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1417 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1418 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001419
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001420 // 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 -07001421 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &(dst_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001422 std::stringstream ss;
1423 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1425 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1426 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1427 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001428
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001429 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1430 // must not overlap in memory
1431 if (src_image_state->image == dst_image_state->image) {
1432 for (uint32_t j = 0; j < region_count; j++) {
1433 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1434 std::stringstream ss;
1435 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1437 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1438 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001439 }
1440 }
1441 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001442 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001443
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001444 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1445 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1446 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1447 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1448 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1449 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1450 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1451 skip |=
1452 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1453 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1454 }
1455 } else {
1456 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1457 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1458 if (srcSize != destSize) {
1459 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1460 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1461 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1462 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001463 }
1464 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001465
Dave Houlton33c22b72017-02-28 13:16:02 -07001466 // Source and dest image sample counts must match
1467 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
1468 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
1469 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 -06001470 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01185, "IMAGE", "%s %s", str,
1471 validation_error_map[VALIDATION_ERROR_01185]);
Dave Houlton33c22b72017-02-28 13:16:02 -07001472 }
1473
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001474 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1475 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1476 // Validate that SRC & DST images have correct usage flags set
1477 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1478 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1479 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1480 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
1481 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1482 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1483 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001484 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
1485 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_01180);
1486 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
1487 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_01183);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001488 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1489 "vkCmdCopyImage()");
1490 }
1491
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001492 return skip;
1493}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001494
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001495void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001496 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1497 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
1498 // Make sure that all image slices are updated to correct layout
1499 for (uint32_t i = 0; i < region_count; ++i) {
1500 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
1501 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
1502 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001503 // Update bindings between images and cmd buffer
1504 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1505 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07001506 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001507 cb_node->validate_functions.push_back(function);
1508 function = [=]() {
1509 SetImageMemoryValid(device_data, dst_image_state, true);
1510 return false;
1511 };
1512 cb_node->validate_functions.push_back(function);
1513 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1514}
1515
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001516// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1517// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1518// to that same cmd buffer by separate thread are not changing state from underneath us
1519// Track the last cmd buffer touched by this thread
1520static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1521 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1522 if (pCB->drawCount[i]) return true;
1523 }
1524 return false;
1525}
1526
1527// Returns true if sub_rect is entirely contained within rect
1528static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1529 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1530 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1531 return false;
1532 return true;
1533}
1534
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001535bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1536 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001537 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001538 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1539
1540 bool skip = false;
1541 if (cb_node) {
1542 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001543 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001544 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1545 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1546 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1547 // 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 -07001548 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
1549 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001550 skip |=
1551 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1552 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1553 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1554 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1555 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001556 }
1557 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1558 }
1559
1560 // Validate that attachment is in reference list of active subpass
1561 if (cb_node->activeRenderPass) {
1562 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1563 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001564 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001565
1566 for (uint32_t i = 0; i < attachmentCount; i++) {
1567 auto clear_desc = &pAttachments[i];
1568 VkImageView image_view = VK_NULL_HANDLE;
1569
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001570 if (0 == clear_desc->aspectMask) {
1571 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001572 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001573 validation_error_map[VALIDATION_ERROR_01128]);
1574 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1575 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001576 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001577 validation_error_map[VALIDATION_ERROR_01126]);
1578 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001579 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001580 skip |=
1581 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001582 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01114, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001583 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1584 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001585 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1586 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001587 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer),
1588 __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001589 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1590 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001591 } else {
1592 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001593 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001594 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001595 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1596 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1597 char const str[] =
1598 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1599 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001600 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001601 validation_error_map[VALIDATION_ERROR_01125]);
1602 }
1603 } else { // Must be depth and/or stencil
1604 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1605 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1606 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1607 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001608 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001609 validation_error_map[VALIDATION_ERROR_01127]);
1610 }
1611 if (!subpass_desc->pDepthStencilAttachment ||
1612 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1613 skip |= log_msg(
1614 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001615 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001616 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001617 } else {
1618 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1619 }
1620 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001621 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001622 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001623 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001624 // The rectangular region specified by a given element of pRects must be contained within the render area of
1625 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001626 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
1627 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
1628 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001629 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1630 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01115, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001631 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1632 "the current render pass instance. %s",
1633 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001634 }
1635 // The layers specified by a given element of pRects must be contained within every attachment that
1636 // pAttachments refers to
1637 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1638 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1639 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1640 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001641 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1642 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01116, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001643 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1644 "pAttachment[%d]. %s",
1645 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001646 }
1647 }
1648 }
1649 }
1650 }
1651 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001652}
1653
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001654bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001655 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001656 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001657 bool skip = false;
1658 if (cb_node && src_image_state && dst_image_state) {
1659 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1660 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
1661 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1662 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001663
1664 // For each region, the number of layers in the image subresource should not be zero
1665 // For each region, src and dest image aspect must be color only
1666 for (uint32_t i = 0; i < regionCount; i++) {
1667 if (pRegions[i].srcSubresource.layerCount == 0) {
1668 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001669 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 -07001670 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1671 "IMAGE", str);
1672 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001673 if (pRegions[i].dstSubresource.layerCount == 0) {
1674 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001675 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 -07001676 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1677 "IMAGE", str);
1678 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001679 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1680 skip |= log_msg(
1681 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1682 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1683 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1684 validation_error_map[VALIDATION_ERROR_01339]);
1685 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001686 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1687 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1688 char const str[] =
1689 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1691 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1692 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1693 }
1694 }
1695
1696 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1697 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001698 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 -07001699 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1700 "IMAGE", str);
1701 }
1702 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1703 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001704 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 -07001705 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1706 str);
1707 }
1708 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1709 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1710 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1711 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1712 str, validation_error_map[VALIDATION_ERROR_01320]);
1713 }
1714 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1715 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1717 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1718 str, validation_error_map[VALIDATION_ERROR_01321]);
1719 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001720 } else {
1721 assert(0);
1722 }
1723 return skip;
1724}
1725
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001726void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1727 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001728 // Update bindings between images and cmd buffer
1729 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1730 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1731
1732 std::function<bool()> function = [=]() {
1733 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1734 };
1735 cb_node->validate_functions.push_back(function);
1736 function = [=]() {
1737 SetImageMemoryValid(device_data, dst_image_state, true);
1738 return false;
1739 };
1740 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001741 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001742}
1743
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001744bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001745 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1746 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1747
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001748 bool skip = false;
1749 if (cb_node && src_image_state && dst_image_state) {
1750 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001751 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001752 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001753 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001754 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1755 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1756 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001757 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001758 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001759 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001760 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1761 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001762
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001763 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001764 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001765 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1766 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1767 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1768 std::stringstream ss;
1769 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1770 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1771 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1772 "%s", ss.str().c_str());
1773 }
1774 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1775 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1776 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1777 std::stringstream ss;
1778 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1779 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1780 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1781 "%s", ss.str().c_str());
1782 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001783 if (pRegions[i].srcSubresource.layerCount == 0) {
1784 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1785 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 -07001786 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1787 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001788 }
1789 if (pRegions[i].dstSubresource.layerCount == 0) {
1790 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1791 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 -07001792 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1793 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001794 }
1795
1796 // Check that src/dst layercounts match
1797 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1798 skip |=
1799 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1800 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1801 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1802 i, validation_error_map[VALIDATION_ERROR_01304]);
1803 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001804
1805 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1806 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1807 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1808 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1809 validation_error_map[VALIDATION_ERROR_01303]);
1810 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001811 }
1812
1813 VkFormat src_format = src_image_state->createInfo.format;
1814 VkFormat dst_format = dst_image_state->createInfo.format;
1815
1816 // Validate consistency for unsigned formats
1817 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1818 std::stringstream ss;
1819 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1820 << "the other one must also have unsigned integer format. "
1821 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1822 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1823 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1824 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1825 }
1826
1827 // Validate consistency for signed formats
1828 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1829 std::stringstream ss;
1830 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1831 << "the other one must also have signed integer format. "
1832 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1833 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1834 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1835 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1836 }
1837
1838 // Validate aspect bits and formats for depth/stencil images
1839 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
1840 if (src_format != dst_format) {
1841 std::stringstream ss;
1842 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1843 << "stencil, the other one must have exactly the same format. "
1844 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1845 << string_VkFormat(dst_format);
1846 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1847 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1848 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1849 }
1850
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001851 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001852 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001853
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001854 if (vk_format_is_depth_and_stencil(src_format)) {
1855 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1856 std::stringstream ss;
1857 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1858 "VK_IMAGE_ASPECT_DEPTH_BIT "
1859 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1860 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1861 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1862 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1863 }
1864 } else if (vk_format_is_stencil_only(src_format)) {
1865 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1866 std::stringstream ss;
1867 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1868 << "set in both the srcImage and dstImage";
1869 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1870 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1871 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1872 }
1873 } else if (vk_format_is_depth_only(src_format)) {
1874 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1875 std::stringstream ss;
1876 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1877 << "set in both the srcImage and dstImage";
1878 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1879 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1880 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1881 }
1882 }
1883 }
1884 }
1885
1886 // Validate filter
1887 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1888 std::stringstream ss;
1889 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1890 << "then filter must be VK_FILTER_NEAREST.";
1891 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1892 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1893 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1894 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001895 } else {
1896 assert(0);
1897 }
1898 return skip;
1899}
1900
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001901void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1902 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001903 // Update bindings between images and cmd buffer
1904 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1905 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1906
1907 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1908 cb_node->validate_functions.push_back(function);
1909 function = [=]() {
1910 SetImageMemoryValid(device_data, dst_image_state, true);
1911 return false;
1912 };
1913 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001914 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001915}
1916
Tony Barbourdf013b92017-01-25 12:53:48 -07001917// This validates that the initial layout specified in the command buffer for
1918// the IMAGE is the same
1919// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001920bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1921 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001922 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001923 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001924 for (auto cb_image_data : pCB->imageLayoutMap) {
1925 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001926
Jeremy Hayes55b6c292017-02-28 09:44:45 -07001927 if (FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001928 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1929 // TODO: Set memory invalid which is in mem_tracker currently
1930 } else if (imageLayout != cb_image_data.second.initialLayout) {
1931 if (cb_image_data.first.hasSubresource) {
Dave Houltoneba86e22017-03-02 14:56:23 -07001932 skip |= log_msg(
1933 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1934 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1935 "Cannot submit cmd buffer using image (0x%" PRIx64
1936 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1937 "with layout %s when first use is %s.",
1938 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
1939 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
1940 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001941 } else {
Dave Houltoneba86e22017-03-02 14:56:23 -07001942 skip |=
1943 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1944 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1945 "Cannot submit cmd buffer using image (0x%" PRIx64
1946 ") with layout %s when "
1947 "first use is %s.",
1948 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), string_VkImageLayout(imageLayout),
1949 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001950 }
1951 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001952 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001953 }
1954 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001955 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001956}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001957
Tony Barbourdf013b92017-01-25 12:53:48 -07001958void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1959 for (auto cb_image_data : pCB->imageLayoutMap) {
1960 VkImageLayout imageLayout;
1961 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1962 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1963 }
1964}
1965
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001966// Print readable FlagBits in FlagMask
1967static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1968 std::string result;
1969 std::string separator;
1970
1971 if (accessMask == 0) {
1972 result = "[None]";
1973 } else {
1974 result = "[";
1975 for (auto i = 0; i < 32; i++) {
1976 if (accessMask & (1 << i)) {
1977 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1978 separator = " | ";
1979 }
1980 }
1981 result = result + "]";
1982 }
1983 return result;
1984}
1985
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001986// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1987// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001988// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001989static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
1990 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
1991 const char *type) {
1992 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1993 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001994
1995 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
1996 if (accessMask & ~(required_bit | optional_bits)) {
1997 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001998 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1999 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002000 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2001 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002002 }
2003 } else {
2004 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002005 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2006 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002007 "%s AccessMask %d %s must contain at least one of access bits %d "
2008 "%s when layout is %s, unless the app has previously added a "
2009 "barrier for this transition.",
2010 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2011 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002012 } else {
2013 std::string opt_bits;
2014 if (optional_bits != 0) {
2015 std::stringstream ss;
2016 ss << optional_bits;
2017 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2018 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002019 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2020 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002021 "%s AccessMask %d %s must have required access bit %d %s %s when "
2022 "layout is %s, unless the app has previously added a barrier for "
2023 "this transition.",
2024 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2025 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002026 }
2027 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002028 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002029}
2030
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002031bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
2032 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
2033 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002034
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002035 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002036 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002037 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
2038 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
2039 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2040 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002041 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002042 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
2043 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
2044 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2045 break;
2046 }
2047 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
2048 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
2049 break;
2050 }
2051 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
2052 skip |= ValidateMaskBits(
2053 device_data, cmdBuffer, accessMask, layout, 0,
2054 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
2055 type);
2056 break;
2057 }
2058 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
2059 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
2060 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
2061 break;
2062 }
2063 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
2064 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
2065 break;
2066 }
2067 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
2068 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
2069 break;
2070 }
2071 case VK_IMAGE_LAYOUT_UNDEFINED: {
2072 if (accessMask != 0) {
2073 // TODO: Verify against Valid Use section spec
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002074 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2075 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002076 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2077 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
2078 }
2079 break;
2080 }
2081 case VK_IMAGE_LAYOUT_GENERAL:
2082 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002083 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002084 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002085}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002086
2087// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002088// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2089// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002090bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002091 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2092 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002093 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2094 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2095 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2096 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002097 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
2098 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
2099 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
2100 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002101 }
2102 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002103 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002104}
2105
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002106bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2107 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002108 bool skip = false;
2109
2110 // Track when we're observing the first use of an attachment
2111 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2112 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2113 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
2114 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2115 auto attach_index = subpass.pColorAttachments[j].attachment;
2116 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2117
2118 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002119 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
2120 // This is ideal.
2121 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002122
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002123 case VK_IMAGE_LAYOUT_GENERAL:
2124 // May not be optimal; TODO: reconsider this warning based on other constraints?
2125 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2126 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2127 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2128 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002129
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002130 default:
2131 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2132 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2133 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2134 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002135 }
2136
2137 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002138 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2139 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002140 }
2141 attach_first_use[attach_index] = false;
2142 }
2143 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2144 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002145 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2146 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2147 // These are ideal.
2148 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002149
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002150 case VK_IMAGE_LAYOUT_GENERAL:
2151 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2152 // doing a bunch of transitions.
2153 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2154 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2155 "GENERAL layout for depth attachment may not give optimal performance.");
2156 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002157
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002158 default:
2159 // No other layouts are acceptable
2160 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2161 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2162 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2163 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2164 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002165 }
2166
2167 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2168 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002169 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2170 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002171 }
2172 attach_first_use[attach_index] = false;
2173 }
2174 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2175 auto attach_index = subpass.pInputAttachments[j].attachment;
2176 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2177
2178 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002179 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2180 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2181 // These are ideal.
2182 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002183
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002184 case VK_IMAGE_LAYOUT_GENERAL:
2185 // May not be optimal. TODO: reconsider this warning based on other constraints.
2186 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2187 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2188 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2189 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002190
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002191 default:
2192 // No other layouts are acceptable
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002193 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2194 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002195 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2196 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002197 }
2198
2199 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002200 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2201 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002202 }
2203 attach_first_use[attach_index] = false;
2204 }
2205 }
2206 return skip;
2207}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002208
2209// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002210bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2211 VkDeviceSize offset, VkDeviceSize end_offset) {
2212 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2213 bool skip = false;
2214 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2215 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002216 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2217 for (auto image_handle : mem_info->bound_images) {
2218 auto img_it = mem_info->bound_ranges.find(image_handle);
2219 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002220 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002221 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002222 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002223 for (auto layout : layouts) {
2224 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002225 skip |= log_msg(
2226 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
2227 reinterpret_cast<const uint64_t &>(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2228 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2229 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
2230 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002231 }
2232 }
2233 }
2234 }
2235 }
2236 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002237 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002238}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002239
2240// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2241// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002242static 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 -07002243 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2244 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002245 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002246
2247 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002248 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002249 if (strict) {
2250 correct_usage = ((actual & desired) == desired);
2251 } else {
2252 correct_usage = ((actual & desired) != 0);
2253 }
2254 if (!correct_usage) {
2255 if (msgCode == -1) {
2256 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltoneba86e22017-03-02 14:56:23 -07002257 skip = log_msg(
2258 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2259 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation.",
2260 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002261 } else {
2262 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002263 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2264 "Invalid usage flag for %s 0x%" PRIxLEAST64
2265 " used by %s. In this case, %s should have %s set during creation. %s",
2266 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002267 }
2268 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002269 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002270}
2271
2272// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2273// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002274bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002275 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002276 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002277 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2278 msgCode, "image", func_name, usage_string);
2279}
2280
2281// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2282// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002283bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002284 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002285 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002286 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2287 msgCode, "buffer", func_name, usage_string);
2288}
2289
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002290bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002291 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002292 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2293
Mark Lobodzinski96210742017-02-09 10:33:46 -07002294 // TODO: Add check for VALIDATION_ERROR_00658
Mark Lobodzinski96210742017-02-09 10:33:46 -07002295 // TODO: Add check for VALIDATION_ERROR_00667
2296 // TODO: Add check for VALIDATION_ERROR_00668
2297 // TODO: Add check for VALIDATION_ERROR_00669
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002298
2299 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
2300 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2301 VALIDATION_ERROR_00666, "DS",
2302 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
2303 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
2304 validation_error_map[VALIDATION_ERROR_00666]);
2305 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06002306
2307 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
2308 skip |=
2309 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2310 DRAWSTATE_INVALID_FEATURE, "DS",
2311 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
2312 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
2313 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06002314
2315 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
2316 skip |=
2317 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2318 DRAWSTATE_INVALID_FEATURE, "DS",
2319 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
2320 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
2321 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07002322 return skip;
2323}
2324
2325void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2326 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2327 GetBufferMap(device_data)
2328 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2329}
2330
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002331bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2332 bool skip = false;
2333 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002334 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2335 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002336 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002337 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2338 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002339 skip |= ValidateBufferUsageFlags(
2340 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 -07002341 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2342 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002343 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002344}
2345
2346void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2347 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2348}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002349
2350// For the given format verify that the aspect masks make sense
2351bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2352 const char *func_name) {
2353 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2354 bool skip = false;
2355 if (vk_format_is_color(format)) {
2356 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2357 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2358 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2359 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2360 validation_error_map[VALIDATION_ERROR_00741]);
2361 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2362 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2363 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2364 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2365 validation_error_map[VALIDATION_ERROR_00741]);
2366 }
2367 } else if (vk_format_is_depth_and_stencil(format)) {
2368 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
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: Depth/stencil image formats must have "
2372 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2373 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2374 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2375 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
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: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2379 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2380 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2381 }
2382 } else if (vk_format_is_depth_only(format)) {
2383 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2384 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2385 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2386 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2387 validation_error_map[VALIDATION_ERROR_00741]);
2388 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2390 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2391 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2392 validation_error_map[VALIDATION_ERROR_00741]);
2393 }
2394 } else if (vk_format_is_stencil_only(format)) {
2395 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
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: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2399 validation_error_map[VALIDATION_ERROR_00741]);
2400 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2401 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2402 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2403 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2404 validation_error_map[VALIDATION_ERROR_00741]);
2405 }
2406 }
2407 return skip;
2408}
2409
2410bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2411 const char *func_name) {
2412 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2413 bool skip = false;
2414 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002415 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski602de982017-02-09 11:01:33 -07002416 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2417 validation_error_map[VALIDATION_ERROR_00768]);
2418 }
2419 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski602de982017-02-09 11:01:33 -07002421 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2422 validation_error_map[VALIDATION_ERROR_00769]);
2423 }
2424 return skip;
2425}
2426
2427bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2428 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2429 bool skip = false;
2430 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2431 if (image_state) {
2432 skip |= ValidateImageUsageFlags(
2433 device_data, image_state,
2434 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2435 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2436 false, -1, "vkCreateImageView()",
2437 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2438 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2439 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2440 // Checks imported from image layer
2441 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2442 std::stringstream ss;
2443 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2444 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2445 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002446 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski602de982017-02-09 11:01:33 -07002447 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2448 }
2449 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2450 std::stringstream ss;
2451 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2452 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2453 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002454 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski602de982017-02-09 11:01:33 -07002455 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2456 }
2457 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2458 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2459
2460 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2461 VkFormat image_format = image_state->createInfo.format;
2462 VkFormat view_format = create_info->format;
2463 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2464
2465 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2466 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2467 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2468 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2469 std::stringstream ss;
2470 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2471 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2472 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2473 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002474 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski602de982017-02-09 11:01:33 -07002475 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2476 validation_error_map[VALIDATION_ERROR_02171]);
2477 }
2478 } else {
2479 // Format MUST be IDENTICAL to the format the image was created with
2480 if (image_format != view_format) {
2481 std::stringstream ss;
2482 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2483 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2484 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002485 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Mark Lobodzinski602de982017-02-09 11:01:33 -07002486 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2487 validation_error_map[VALIDATION_ERROR_02172]);
2488 }
2489 }
2490
2491 // Validate correct image aspect bits for desired formats and format consistency
2492 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2493 }
2494 return skip;
2495}
2496
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002497void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2498 auto image_view_map = GetImageViewMap(device_data);
2499 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2500
2501 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002502 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002503 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002504}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002505
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002506bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2507 BUFFER_STATE *dst_buffer_state) {
2508 bool skip = false;
2509 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2510 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2511 // Validate that SRC & DST buffers have correct usage flags set
2512 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2513 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2514 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2515 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2516 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2517 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2518 return skip;
2519}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002520
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002521void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2522 BUFFER_STATE *dst_buffer_state) {
2523 // Update bindings between buffers and cmd buffer
2524 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2525 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2526
2527 std::function<bool()> function = [=]() {
2528 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2529 };
2530 cb_node->validate_functions.push_back(function);
2531 function = [=]() {
2532 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2533 return false;
2534 };
2535 cb_node->validate_functions.push_back(function);
2536 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2537}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002538
2539static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2540 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2541 bool skip = false;
2542 auto buffer_state = GetBufferState(device_data, buffer);
2543 if (!buffer_state) {
2544 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2545 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2546 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2547 } else {
2548 if (buffer_state->in_use.load()) {
2549 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2550 __LINE__, VALIDATION_ERROR_00676, "DS",
2551 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2552 validation_error_map[VALIDATION_ERROR_00676]);
2553 }
2554 }
2555 return skip;
2556}
2557
2558bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2559 VK_OBJECT *obj_struct) {
2560 *image_view_state = GetImageViewState(device_data, image_view);
2561 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2562 if (GetDisables(device_data)->destroy_image_view) return false;
2563 bool skip = false;
2564 if (*image_view_state) {
2565 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2566 }
2567 return skip;
2568}
2569
2570void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2571 VK_OBJECT obj_struct) {
2572 // Any bound cmd buffers are now invalid
2573 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2574 (*GetImageViewMap(device_data)).erase(image_view);
2575}
2576
2577bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2578 *buffer_state = GetBufferState(device_data, buffer);
2579 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2580 if (GetDisables(device_data)->destroy_buffer) return false;
2581 bool skip = false;
2582 if (*buffer_state) {
2583 skip |= validateIdleBuffer(device_data, buffer);
2584 }
2585 return skip;
2586}
2587
2588void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2589 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2590 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2591 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2592 if (mem_info) {
2593 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2594 }
2595 }
2596 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2597 GetBufferMap(device_data)->erase(buffer_state->buffer);
2598}
2599
2600bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2601 VK_OBJECT *obj_struct) {
2602 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2603 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2604 if (GetDisables(device_data)->destroy_buffer_view) return false;
2605 bool skip = false;
2606 if (*buffer_view_state) {
2607 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2608 }
2609 return skip;
2610}
2611
2612void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2613 VK_OBJECT obj_struct) {
2614 // Any bound cmd buffers are now invalid
2615 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2616 GetBufferViewMap(device_data)->erase(buffer_view);
2617}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002618
2619bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2620 bool skip = false;
2621 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
2622 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2623 // Validate that DST buffer has correct usage flags set
2624 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2625 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2626 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2627 return skip;
2628}
2629
2630void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2631 std::function<bool()> function = [=]() {
2632 SetBufferMemoryValid(device_data, buffer_state, true);
2633 return false;
2634 };
2635 cb_node->validate_functions.push_back(function);
2636 // Update bindings between buffer and cmd buffer
2637 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2638 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2639}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002640
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002641bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2642 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002643 bool skip = false;
2644
2645 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002646 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
2647 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002648 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 -07002649 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
2650 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2651 "must be 0 and 1, respectively. %s",
2652 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2653 validation_error_map[VALIDATION_ERROR_01746]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002654 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002655 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002656
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002657 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
2658 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002659 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 -07002660 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
2661 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2662 "must be 0 and 1, respectively. %s",
2663 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2664 validation_error_map[VALIDATION_ERROR_01747]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002665 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002666 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002667
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002668 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2669 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2670 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2671 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
2672 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2673 "%d. For 3D images these must be 0 and 1, respectively. %s",
2674 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
2675 validation_error_map[VALIDATION_ERROR_01281]);
2676 }
2677 }
2678
2679 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2680 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
2681 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2682 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
2683 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2684 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2685 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
2686 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2687 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2688 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2689 }
2690
2691 // BufferOffset must be a multiple of 4
2692 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2693 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2694 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
2695 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2696 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2697 }
2698
2699 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2700 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2701 skip |= log_msg(
2702 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2703 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
2704 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2705 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2706 validation_error_map[VALIDATION_ERROR_01265]);
2707 }
2708
2709 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2710 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2711 skip |= log_msg(
2712 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2713 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
2714 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2715 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2716 validation_error_map[VALIDATION_ERROR_01266]);
2717 }
2718
2719 // subresource aspectMask must have exactly 1 bit set
2720 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2721 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2722 if (aspect_mask_bits.count() != 1) {
2723 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2724 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
2725 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2726 validation_error_map[VALIDATION_ERROR_01280]);
2727 }
2728
2729 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002730 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002731 skip |= log_msg(
2732 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2733 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
2734 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
2735 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
2736 validation_error_map[VALIDATION_ERROR_01279]);
2737 }
2738
2739 // Checks that apply only to compressed images
2740 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2741 // reserves a place for these compressed image checks. This block of code could move there once the image
2742 // stuff is moved into core validation.
2743 if (vk_format_is_compressed(image_state->createInfo.format)) {
2744 auto block_size = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2745
2746 // BufferRowLength must be a multiple of block width
2747 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002748 skip |= log_msg(
2749 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002750 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
2751 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2752 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002753 }
2754
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002755 // BufferRowHeight must be a multiple of block height
2756 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002757 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 -07002758 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
2759 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2760 "height (%d). %s.",
2761 function, i, pRegions[i].bufferImageHeight, block_size.height,
2762 validation_error_map[VALIDATION_ERROR_01272]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002763 }
2764
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002765 // image offsets must be multiples of block dimensions
2766 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
Dave Houlton75967fc2017-03-06 17:21:16 -07002767 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
2768 (vk_safe_modulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002769 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2770 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
2771 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2772 "width & height (%d, %d). %s.",
2773 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2774 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002775 }
2776
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002777 // bufferOffset must be a multiple of block size (linear bytes)
2778 size_t block_size_in_bytes = vk_format_get_size(image_state->createInfo.format);
2779 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
2780 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2781 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01274, "IMAGE",
2782 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
2783 ") must be a multiple of the compressed image's texel block "
2784 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
2785 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2786 validation_error_map[VALIDATION_ERROR_01274]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002787 }
Dave Houlton67e9b532017-03-02 17:00:10 -07002788
2789 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07002790 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton67e9b532017-03-02 17:00:10 -07002791 if ((vk_safe_modulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002792 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
2793 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2794 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01275, "IMAGE",
2795 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
2796 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
2797 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
2798 mip_extent.width, validation_error_map[VALIDATION_ERROR_01275]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002799 }
2800
2801 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
2802 if ((vk_safe_modulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002803 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
2804 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2805 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01276, "IMAGE",
2806 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
2807 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
2808 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
2809 mip_extent.height, validation_error_map[VALIDATION_ERROR_01276]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002810 }
2811
2812 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
2813 if ((vk_safe_modulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002814 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
2815 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2816 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01277, "IMAGE",
2817 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
2818 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
2819 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
2820 mip_extent.depth, validation_error_map[VALIDATION_ERROR_01277]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002821 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002822 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002823 }
2824
2825 return skip;
2826}
2827
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002828static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
2829 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002830 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002831 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002832
2833 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002834 VkExtent3D extent = pRegions[i].imageExtent;
2835 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002836
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002837 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
2838 {
2839 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2840 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
2841 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
2842 extent.height, extent.depth);
2843 }
2844
2845 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
2846
2847 // 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 -07002848 if (vk_format_is_compressed(image_info->format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002849 auto block_extent = vk_format_compressed_texel_block_extents(image_info->format);
2850 if (image_extent.width % block_extent.width) {
2851 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
2852 }
2853 if (image_extent.height % block_extent.height) {
2854 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
2855 }
2856 if (image_extent.depth % block_extent.depth) {
2857 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
2858 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002859 }
2860
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002861 if (ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002862 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 -07002863 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002864 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002865 }
2866 }
2867
2868 return skip;
2869}
2870
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002871static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2872 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2873 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2874 bool skip = false;
2875
2876 VkDeviceSize buffer_size = buff_state->createInfo.size;
2877
2878 for (uint32_t i = 0; i < regionCount; i++) {
2879 VkExtent3D copy_extent = pRegions[i].imageExtent;
2880
2881 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2882 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2883 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2884
Dave Houltonf3229d52017-02-21 15:59:08 -07002885 // Handle special buffer packing rules for specific depth/stencil formats
2886 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2887 unit_size = vk_format_get_size(VK_FORMAT_S8_UINT);
2888 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2889 switch (image_state->createInfo.format) {
2890 case VK_FORMAT_D16_UNORM_S8_UINT:
2891 unit_size = vk_format_get_size(VK_FORMAT_D16_UNORM);
2892 break;
2893 case VK_FORMAT_D32_SFLOAT_S8_UINT:
2894 unit_size = vk_format_get_size(VK_FORMAT_D32_SFLOAT);
2895 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002896 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07002897 case VK_FORMAT_D24_UNORM_S8_UINT:
2898 unit_size = 4;
2899 break;
2900 default:
2901 break;
2902 }
2903 }
2904
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002905 if (vk_format_is_compressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002906 // Switch to texel block units, rounding up for any partially-used blocks
2907 auto block_dim = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2908 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
2909 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
2910
2911 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
2912 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
2913 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002914 }
2915
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002916 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
2917 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2918 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
2919 // TODO: Issure warning here? Already warned in ValidateImageBounds()...
2920 } else {
2921 // Calculate buffer offset of final copied byte, + 1.
2922 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
2923 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2924 max_buffer_offset *= unit_size; // convert to bytes
2925 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002926
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002927 if (buffer_size < max_buffer_offset) {
2928 skip |=
2929 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2930 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
2931 i, buffer_size, validation_error_map[msg_code]);
2932 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002933 }
2934 }
2935
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002936 return skip;
2937}
2938
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002939bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002940 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002941 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002942 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2943 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2944
2945 // Validate command buffer state
2946 if (CB_RECORDING != cb_node->state) {
2947 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2948 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2949 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2950 validation_error_map[VALIDATION_ERROR_01258]);
2951 } else {
2952 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2953 }
2954
2955 // Command pool must support graphics, compute, or transfer operations
2956 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2957
2958 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2959 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2960 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2961 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2962 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2963 "or transfer capabilities. %s.",
2964 validation_error_map[VALIDATION_ERROR_01259]);
2965 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002966 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002967 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002968 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002969 VALIDATION_ERROR_01246);
2970
2971 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2972 VALIDATION_ERROR_01249);
2973 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002974 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002975
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002976 // Validate that SRC image & DST buffer have correct usage flags set
2977 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2978 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002979 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002980 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002981 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
2982 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002983 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
2984 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01251);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002985 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06002986 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002987 }
2988 return skip;
2989}
2990
2991void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002992 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
2993 VkImageLayout src_image_layout) {
2994 // Make sure that all image slices are updated to correct layout
2995 for (uint32_t i = 0; i < region_count; ++i) {
2996 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
2997 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002998 // Update bindings between buffer/image and cmd buffer
2999 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003000 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003001
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003002 std::function<bool()> function = [=]() {
3003 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
3004 };
3005 cb_node->validate_functions.push_back(function);
3006 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003007 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003008 return false;
3009 };
3010 cb_node->validate_functions.push_back(function);
3011
3012 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003013}
3014
3015bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003016 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003017 const VkBufferImageCopy *pRegions, const char *func_name) {
3018 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3019 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
3020
3021 // Validate command buffer state
3022 if (CB_RECORDING != cb_node->state) {
3023 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3024 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
3025 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
3026 validation_error_map[VALIDATION_ERROR_01240]);
3027 } else {
3028 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
3029 }
3030
3031 // Command pool must support graphics, compute, or transfer operations
3032 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3033 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3034 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3035 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3036 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
3037 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
3038 "or transfer capabilities. %s.",
3039 validation_error_map[VALIDATION_ERROR_01241]);
3040 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003041 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003042 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003043 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003044 VALIDATION_ERROR_01227);
3045 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
3046 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003047 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003048 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003049 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003050 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3051 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
3052 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003053 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
3054 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003055 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
3056 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01234);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003057 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
3058 "vkCmdCopyBufferToImage()");
3059 }
3060 return skip;
3061}
3062
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003063void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003064 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
3065 VkImageLayout dst_image_layout) {
3066 // Make sure that all image slices are updated to correct layout
3067 for (uint32_t i = 0; i < region_count; ++i) {
3068 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
3069 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003070 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003071 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003072 std::function<bool()> function = [=]() {
3073 SetImageMemoryValid(device_data, dst_image_state, true);
3074 return false;
3075 };
3076 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003077 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003078 cb_node->validate_functions.push_back(function);
3079
3080 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003081}
Mike Weiblen672b58b2017-02-21 14:32:53 -07003082
3083bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
3084 const auto report_data = core_validation::GetReportData(device_data);
3085 bool skip = false;
3086 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
3087
3088 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
3089 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
3090 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
3091 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003092 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3093 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00733, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003094 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
3095 validation_error_map[VALIDATION_ERROR_00733]);
3096 }
3097
3098 IMAGE_STATE *image_entry = GetImageState(device_data, image);
3099 if (!image_entry) {
3100 return skip;
3101 }
3102
3103 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
3104 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003105 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3106 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00732, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003107 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
3108 validation_error_map[VALIDATION_ERROR_00732]);
3109 }
3110
3111 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
3112 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003113 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3114 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00739, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003115 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
3116 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
3117 }
3118
3119 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
3120 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003121 skip |=
3122 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3123 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00740, "IMAGE",
3124 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
3125 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003126 }
3127
3128 // VU 00741: subresource's aspect must be compatible with image's format.
3129 const VkFormat img_format = image_entry->createInfo.format;
3130 if (vk_format_is_color(img_format)) {
3131 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
3132 skip |= log_msg(
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003133 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3134 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00741, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003135 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
3136 validation_error_map[VALIDATION_ERROR_00741]);
3137 }
3138 } else if (vk_format_is_depth_or_stencil(img_format)) {
3139 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003140 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3141 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00741, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003142 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
3143 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
3144 validation_error_map[VALIDATION_ERROR_00741]);
3145 }
3146 }
3147 return skip;
3148}