blob: 2dca9ed048cfd1785fc9245c0c086b296ed2cb77 [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 Lobodzinski91c28262017-03-22 13:06:12 -0600369 skip |=
370 log_msg(core_validation::GetReportData(device_data), VK_DEBUG_REPORT_ERROR_BIT_EXT,
371 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(pCB->commandBuffer), __LINE__,
372 DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
373 "For image 0x%" PRIxLEAST64 " you cannot transition the layout of aspect %d from %s when current layout is %s.",
374 reinterpret_cast<const uint64_t &>(mem_barrier->image), aspect, string_VkImageLayout(mem_barrier->oldLayout),
375 string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700376 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700377 return skip;
378}
379
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700380void TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
381 uint32_t level, uint32_t layer, VkImageAspectFlags aspect) {
382 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
383 return;
384 }
385 VkImageSubresource sub = {aspect, level, layer};
386 IMAGE_CMD_BUF_LAYOUT_NODE node;
387 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
388 SetLayout(device_data, pCB, mem_barrier->image, sub,
389 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
390 return;
391 }
392 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
393 // TODO: Set memory invalid
394 }
395 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
396}
397
Dave Houlton10b39482017-03-16 13:18:15 -0600398bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600399 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
400 if (!vk_format_is_color(format)) return false;
401 }
402 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
403 if (!vk_format_has_depth(format)) return false;
404 }
405 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
406 if (!vk_format_has_stencil(format)) return false;
407 }
408 return true;
409}
410
Mike Weiblen62d08a32017-03-07 22:18:27 -0700411// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
412bool ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier, bool new_not_old,
413 VkImageUsageFlags usage_flags, const char *func_name) {
414 const auto report_data = core_validation::GetReportData(device_data);
415 bool skip = false;
416 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
417 UNIQUE_VALIDATION_ERROR_CODE msg_code = VALIDATION_ERROR_UNDEFINED; // sentinel value meaning "no error"
418
419 switch (layout) {
420 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
421 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
422 msg_code = VALIDATION_ERROR_00303;
423 }
424 break;
425 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
426 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
427 msg_code = VALIDATION_ERROR_00304;
428 }
429 break;
430 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
431 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
432 msg_code = VALIDATION_ERROR_00305;
433 }
434 break;
435 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
436 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
437 msg_code = VALIDATION_ERROR_00306;
438 }
439 break;
440 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
441 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
442 msg_code = VALIDATION_ERROR_00307;
443 }
444 break;
445 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
446 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
447 msg_code = VALIDATION_ERROR_00308;
448 }
449 break;
450 default:
451 // Other VkImageLayout values do not have VUs defined in this context.
452 break;
453 }
454
455 if (msg_code != VALIDATION_ERROR_UNDEFINED) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600456 skip |=
457 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
458 reinterpret_cast<const uint64_t &>(img_barrier->image), __LINE__, msg_code, "DS",
459 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image 0x%" PRIx64 " usage flags 0x%" PRIx32 ". %s",
460 func_name, img_barrier, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
461 reinterpret_cast<const uint64_t &>(img_barrier->image), usage_flags, validation_error_map[msg_code]);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700462 }
463 return skip;
464}
465
466// Verify image barriers are compatible with the images they reference.
467bool ValidateBarriersToImages(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t imageMemoryBarrierCount,
468 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700469 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700470 bool skip = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700471 uint32_t level_count = 0;
472 uint32_t layer_count = 0;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700473
Mike Weiblen62d08a32017-03-07 22:18:27 -0700474 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
475 auto img_barrier = &pImageMemoryBarriers[i];
476 if (!img_barrier) continue;
477
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700478 // TODO: Do not iterate over every possibility - consolidate where possible
Mike Weiblen62d08a32017-03-07 22:18:27 -0700479 ResolveRemainingLevelsLayers(device_data, &level_count, &layer_count, img_barrier->subresourceRange,
480 GetImageState(device_data, img_barrier->image));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700481
Mike Weiblen62d08a32017-03-07 22:18:27 -0700482 for (uint32_t j = 0; j < level_count; j++) {
483 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
484 for (uint32_t k = 0; k < layer_count; k++) {
485 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
486 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
487 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
488 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
489 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700490 }
491 }
Mike Weiblen62d08a32017-03-07 22:18:27 -0700492
493 IMAGE_STATE *image_state = GetImageState(device_data, img_barrier->image);
494 if (image_state) {
495 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
496 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
497 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
498 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700499 }
500 return skip;
501}
502
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700503void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
504 const VkImageMemoryBarrier *pImgMemBarriers) {
505 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
506 uint32_t levelCount = 0;
507 uint32_t layerCount = 0;
508
509 for (uint32_t i = 0; i < memBarrierCount; ++i) {
510 auto mem_barrier = &pImgMemBarriers[i];
511 if (!mem_barrier) continue;
512 // TODO: Do not iterate over every possibility - consolidate where possible
513 ResolveRemainingLevelsLayers(device_data, &levelCount, &layerCount, mem_barrier->subresourceRange,
514 GetImageState(device_data, mem_barrier->image));
515
516 for (uint32_t j = 0; j < levelCount; j++) {
517 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
518 for (uint32_t k = 0; k < layerCount; k++) {
519 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
520 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
521 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
522 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
523 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
524 }
525 }
526 }
527}
528
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600529bool VerifyImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
530 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600531 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700532 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600533 const auto image = image_state->image;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700534 bool skip_call = false;
535
536 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
537 uint32_t layer = i + subLayers.baseArrayLayer;
538 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
539 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600540 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
541 if (node.layout != explicit_layout) {
542 // TODO: Improve log message in the next pass
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600543 skip_call |=
544 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
545 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600546 "%s: Cannot use image 0x%" PRIxLEAST64
547 " with specific layout %s that doesn't match the actual current layout %s.",
548 caller, reinterpret_cast<const uint64_t &>(image), string_VkImageLayout(explicit_layout),
549 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600550 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700551 }
552 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600553 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
554 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
555 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700556 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
557 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600558 skip_call |= log_msg(
559 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
560 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
561 "%s: For optimal performance image 0x%" PRIxLEAST64 " layout should be %s instead of GENERAL.", caller,
562 reinterpret_cast<const uint64_t &>(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700563 }
564 } else {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600565 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
566 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600567 "%s: Layout for image 0x%" PRIxLEAST64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s",
568 caller, reinterpret_cast<const uint64_t &>(image), string_VkImageLayout(explicit_layout),
569 string_VkImageLayout(optimal_layout), validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700570 }
571 }
572 return skip_call;
573}
574
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700575void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
576 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700577 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700578 if (!renderPass) return;
579
580 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
581 if (framebuffer_state) {
582 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
583 auto image_view = framebuffer_state->createInfo.pAttachments[i];
584 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
585 }
586 }
587}
588
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700589bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700590 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
591 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700592 const debug_report_data *report_data = core_validation::GetReportData(device_data);
593
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600594 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700595 skip_call |=
596 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
597 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
598 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600599
600 return skip_call;
601 }
602
603 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
604
605 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
606 std::stringstream ss;
607 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
608 skip_call |=
609 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
610 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
611
612 return skip_call;
613 }
614
615 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
616 std::stringstream ss;
617 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
618 skip_call |=
619 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
620 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
621
622 return skip_call;
623 }
624
625 // Validate that format supports usage as color attachment
626 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
627 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
628 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
629 std::stringstream ss;
630 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
631 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
632 skip_call |=
633 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
634 VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
635 }
636 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
637 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
638 std::stringstream ss;
639 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
640 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
641 skip_call |=
642 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
643 VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
644 }
645 }
646
647 // Validate that format supports usage as depth/stencil attachment
648 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
649 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
650 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
651 std::stringstream ss;
652 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
653 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
654 skip_call |=
655 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
656 VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
657 }
658 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
659 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
660 std::stringstream ss;
661 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
662 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
663 skip_call |=
664 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
665 VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
666 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700667 }
668
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700669 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
670 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700671
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700672 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700673 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
674
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700675 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
676 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
677 VALIDATION_ERROR_00716, "Image",
678 "CreateImage extent is 0 for at least one required dimension for image: "
679 "Width = %d Height = %d Depth = %d. %s",
680 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
681 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700682 }
683
684 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
685 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700686 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
687 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
688 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700689 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
690 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
691 "CreateImage extents exceed allowable limits for format: "
692 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
693 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700694 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
695 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700696 }
697
698 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
699 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
700 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
701 (uint64_t)imageGranularity) &
702 ~(uint64_t)imageGranularity;
703
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700704 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700705 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
706 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
707 "CreateImage resource size exceeds allowable maximum "
708 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700709 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700710 }
711
712 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700713 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700714 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
715 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
716 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700717 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700718 }
719
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700720 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700721 skip_call |= log_msg(
722 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
723 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700724 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700725 }
726
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700727 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700728 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
729 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700730 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700731 validation_error_map[VALIDATION_ERROR_02138]);
732 }
733
734 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
735 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
736 VALIDATION_ERROR_00731, "Image",
737 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
738 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
739 validation_error_map[VALIDATION_ERROR_00731]);
740 }
741
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600742 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
743 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
744 VALIDATION_ERROR_02143, "DS",
745 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
746 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
747 validation_error_map[VALIDATION_ERROR_02143]);
748 }
749
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600750 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
751 skip_call |=
752 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
753 DRAWSTATE_INVALID_FEATURE, "DS",
754 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
755 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
756 }
757
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700758 return skip_call;
759}
760
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700761void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700762 IMAGE_LAYOUT_NODE image_state;
763 image_state.layout = pCreateInfo->initialLayout;
764 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700765 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 -0700766 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700767 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
768 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700769}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700770
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700771bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700772 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700773 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700774 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
775 if (disabled->destroy_image) return false;
776 bool skip = false;
777 if (*image_state) {
778 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
779 }
780 return skip;
781}
782
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700783void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700784 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
785 // Clean up memory mapping, bindings and range references for image
786 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700787 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700788 if (mem_info) {
789 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
790 }
791 }
792 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
793 // Remove image from imageMap
794 core_validation::GetImageMap(device_data)->erase(image);
795 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
796 core_validation::GetImageSubresourceMap(device_data);
797
798 const auto &sub_entry = imageSubresourceMap->find(image);
799 if (sub_entry != imageSubresourceMap->end()) {
800 for (const auto &pair : sub_entry->second) {
801 core_validation::GetImageLayoutMap(device_data)->erase(pair);
802 }
803 imageSubresourceMap->erase(sub_entry);
804 }
805}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700806
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700807bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700808 bool skip = false;
809 const debug_report_data *report_data = core_validation::GetReportData(device_data);
810
811 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
812 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
814 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
815 }
816
817 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
818 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
820 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
821 validation_error_map[VALIDATION_ERROR_01088]);
822 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
823 char const str[] = "vkCmdClearColorImage called with compressed image.";
824 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
825 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
826 validation_error_map[VALIDATION_ERROR_01088]);
827 }
828
829 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
830 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
832 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
833 validation_error_map[VALIDATION_ERROR_01084]);
834 }
835 return skip;
836}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700837
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700838void ResolveRemainingLevelsLayers(layer_data *dev_data, VkImageSubresourceRange *range, IMAGE_STATE *image_state) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700839 // If the caller used the special values VK_REMAINING_MIP_LEVELS and VK_REMAINING_ARRAY_LAYERS, resolve them now in our
840 // internal state to the actual values.
841 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
842 range->levelCount = image_state->createInfo.mipLevels - range->baseMipLevel;
843 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700844
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700845 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
846 range->layerCount = image_state->createInfo.arrayLayers - range->baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700847 }
848}
849
850// 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 -0700851void ResolveRemainingLevelsLayers(layer_data *dev_data, uint32_t *levels, uint32_t *layers, VkImageSubresourceRange range,
852 IMAGE_STATE *image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700853 *levels = range.levelCount;
854 *layers = range.layerCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700855 if (range.levelCount == VK_REMAINING_MIP_LEVELS) {
856 *levels = image_state->createInfo.mipLevels - range.baseMipLevel;
857 }
858 if (range.layerCount == VK_REMAINING_ARRAY_LAYERS) {
859 *layers = image_state->createInfo.arrayLayers - range.baseArrayLayer;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700860 }
861}
862
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700863bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700864 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
865 bool skip = false;
866 const debug_report_data *report_data = core_validation::GetReportData(device_data);
867
868 VkImageSubresourceRange resolved_range = range;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700869 ResolveRemainingLevelsLayers(device_data, &resolved_range, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700870
871 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
872 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700873 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
874 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600875 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
876 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700877 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
878 }
879 } else {
880 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
881 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
882 error_code = VALIDATION_ERROR_01101;
883 } else {
884 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
885 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600886 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
887 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, error_code, "DS",
888 "%s: Layout for cleared image is %s but can only be "
889 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
890 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700891 }
892 }
893
894 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
895 uint32_t level = level_index + resolved_range.baseMipLevel;
896 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
897 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
898 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
899 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700900 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700901 if (node.layout != dest_image_layout) {
902 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
903 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
904 error_code = VALIDATION_ERROR_01100;
905 } else {
906 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
907 }
908 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
909 __LINE__, error_code, "DS",
910 "%s: Cannot clear an image whose layout is %s and "
911 "doesn't match the current layout %s. %s",
912 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
913 validation_error_map[error_code]);
914 }
915 }
916 }
917 }
918
919 return skip;
920}
921
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700922void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
923 VkImageLayout dest_image_layout) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700924 VkImageSubresourceRange resolved_range = range;
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700925 ResolveRemainingLevelsLayers(device_data, &resolved_range, GetImageState(device_data, image));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700926
927 for (uint32_t level_index = 0; level_index < resolved_range.levelCount; ++level_index) {
928 uint32_t level = level_index + resolved_range.baseMipLevel;
929 for (uint32_t layer_index = 0; layer_index < resolved_range.layerCount; ++layer_index) {
930 uint32_t layer = layer_index + resolved_range.baseArrayLayer;
931 VkImageSubresource sub = {resolved_range.aspectMask, level, layer};
932 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700933 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
934 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 -0700935 }
936 }
937 }
938}
939
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700940bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700941 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
942 bool skip = false;
943 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700944 auto cb_node = GetCBNode(dev_data, commandBuffer);
945 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700946 if (cb_node && image_state) {
947 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
Mike Schuchardt9c582402017-02-23 15:57:37 -0700948 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
949 VALIDATION_ERROR_01095);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700950 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
951 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
952 for (uint32_t i = 0; i < rangeCount; ++i) {
953 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700954 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700955 }
956 }
957 return skip;
958}
959
960// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700961void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
962 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700963 auto cb_node = GetCBNode(dev_data, commandBuffer);
964 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700965 if (cb_node && image_state) {
966 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
967 std::function<bool()> function = [=]() {
968 SetImageMemoryValid(dev_data, image_state, true);
969 return false;
970 };
971 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700972 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700973 for (uint32_t i = 0; i < rangeCount; ++i) {
974 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
975 }
976 }
977}
978
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700979bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
980 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700981 const VkImageSubresourceRange *pRanges) {
982 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700983 const debug_report_data *report_data = core_validation::GetReportData(device_data);
984
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700985 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700986 auto cb_node = GetCBNode(device_data, commandBuffer);
987 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700988 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700989 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
Mike Schuchardt9c582402017-02-23 15:57:37 -0700990 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
991 VALIDATION_ERROR_01110);
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700992 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
993 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700994 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700995 skip |=
996 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700997 // Image aspect must be depth or stencil or both
998 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
999 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1000 char const str[] =
1001 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
1002 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
1003 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1004 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
1005 }
1006 }
1007 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
1008 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
1009 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1010 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
1011 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001012 }
1013 }
1014 return skip;
1015}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001016
1017// Returns true if [x, xoffset] and [y, yoffset] overlap
1018static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1019 bool result = false;
1020 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1021 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1022
1023 if (intersection_max > intersection_min) {
1024 result = true;
1025 }
1026 return result;
1027}
1028
1029// Returns true if two VkImageCopy structures overlap
1030static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1031 bool result = false;
1032 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1033 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1034 dst->dstSubresource.layerCount))) {
1035 result = true;
1036 switch (type) {
1037 case VK_IMAGE_TYPE_3D:
1038 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1039 // Intentionally fall through to 2D case
1040 case VK_IMAGE_TYPE_2D:
1041 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1042 // Intentionally fall through to 1D case
1043 case VK_IMAGE_TYPE_1D:
1044 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1045 break;
1046 default:
1047 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1048 assert(false);
1049 }
1050 }
1051 return result;
1052}
1053
1054// Returns true if offset and extent exceed image extents
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001055static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001056 bool result = false;
1057 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001058 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1059 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
1060 result = true;
1061 }
1062 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1063 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
1064 result = true;
1065 }
1066 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1067 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
1068 result = true;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001069 }
1070 return result;
1071}
1072
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001073// Test if two VkExtent3D structs are equivalent
1074static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1075 bool result = true;
1076 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1077 (extent->depth != other_extent->depth)) {
1078 result = false;
1079 }
1080 return result;
1081}
1082
1083// Returns the image extent of a specific subresource.
1084static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1085 const uint32_t mip = subresource->mipLevel;
1086 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001087 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
1088 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1089 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1090 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001091 return extent;
1092}
1093
1094// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001095static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001096 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1097}
1098
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001099// Test if the extent argument has any dimensions set to 0.
1100static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1101 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1102}
1103
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001104// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1105static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1106 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1107 VkExtent3D granularity = {0, 0, 0};
1108 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1109 if (pPool) {
1110 granularity =
1111 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
1112 if (vk_format_is_compressed(img->createInfo.format)) {
Mark Lobodzinski13086442017-02-24 08:53:14 -07001113 auto block_size = vk_format_compressed_texel_block_extents(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001114 granularity.width *= block_size.width;
1115 granularity.height *= block_size.height;
1116 }
1117 }
1118 return granularity;
1119}
1120
1121// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1122static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1123 bool valid = true;
1124 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
1125 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
1126 valid = false;
1127 }
1128 return valid;
1129}
1130
1131// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1132static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1133 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1134 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1135 bool skip = false;
1136 VkExtent3D offset_extent = {};
1137 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1138 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1139 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001140 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001141 // 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 -07001142 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001143 skip |=
1144 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1145 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1146 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1147 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1148 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001149 }
1150 } else {
1151 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1152 // integer multiples of the image transfer granularity.
1153 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001154 skip |= log_msg(
1155 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1156 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1157 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1158 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1159 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height, granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001160 }
1161 }
1162 return skip;
1163}
1164
1165// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1166static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1167 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1168 const uint32_t i, const char *function, const char *member) {
1169 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1170 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001171 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001172 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1173 // subresource extent.
1174 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001175 skip |=
1176 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1177 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1178 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1179 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1180 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1181 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001182 }
1183 } else {
1184 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1185 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1186 // subresource extent dimensions.
1187 VkExtent3D offset_extent_sum = {};
1188 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1189 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1190 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1191 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1192 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001193 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1194 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001195 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1196 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1197 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1198 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1199 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1200 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1201 }
1202 }
1203 return skip;
1204}
1205
1206// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1207static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1208 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1209 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1210
1211 bool skip = false;
1212 if (vk_safe_modulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001213 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1214 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001215 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1216 "transfer granularity width (%d).",
1217 function, i, member, value, granularity);
1218 }
1219 return skip;
1220}
1221
1222// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1223static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1224 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1225 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1226 bool skip = false;
1227 if (vk_safe_modulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001228 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1229 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001230 "%s: pRegion[%d].%s (%" PRIdLEAST64
1231 ") must be an even integer multiple of this command buffer's queue family image transfer "
1232 "granularity width (%d).",
1233 function, i, member, value, granularity);
1234 }
1235 return skip;
1236}
1237
1238// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1239bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1240 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1241 const uint32_t i, const char *function) {
1242 bool skip = false;
1243 if (vk_format_is_compressed(img->createInfo.format) == true) {
1244 // TODO: Add granularity checking for compressed formats
1245
1246 // bufferRowLength must be a multiple of the compressed texel block width
1247 // bufferImageHeight must be a multiple of the compressed texel block height
1248 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1249 // bufferOffset must be a multiple of the compressed texel block size in bytes
1250 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1251 // must equal the image subresource width
1252 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1253 // must equal the image subresource height
1254 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1255 // must equal the image subresource depth
1256 } else {
1257 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1258 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1259 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1260 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1261 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1262 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1263 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1264 i, function, "imageExtent");
1265 }
1266 return skip;
1267}
1268
1269// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1270bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1271 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1272 const char *function) {
1273 bool skip = false;
1274 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1275 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1276 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1277 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1278 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1279 function, "extent");
1280 return skip;
1281}
1282
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001283bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001284 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1285 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001286 bool skip = false;
1287 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1288 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1289
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001290 for (uint32_t i = 0; i < region_count; i++) {
1291 if (regions[i].srcSubresource.layerCount == 0) {
1292 std::stringstream ss;
1293 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1294 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1295 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1296 ss.str().c_str());
1297 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001298
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001299 if (regions[i].dstSubresource.layerCount == 0) {
1300 std::stringstream ss;
1301 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1302 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1303 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1304 ss.str().c_str());
1305 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001306
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001307 // For each region the layerCount member of srcSubresource and dstSubresource must match
1308 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1309 std::stringstream ss;
1310 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i << "] do not match";
1311 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1312 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1313 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1314 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001315
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001316 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1317 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1318 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1319 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1320 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1321 validation_error_map[VALIDATION_ERROR_01197]);
1322 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001323
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001324 // For each region, the aspectMask member of srcSubresource must be present in the source image
1325 if (!VerifyAspectsPresent(regions[i].srcSubresource.aspectMask, src_image_state->createInfo.format)) {
1326 std::stringstream ss;
1327 ss << "vkCmdCopyImage: pRegion[" << i
1328 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1329 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1330 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01200, "IMAGE", "%s. %s",
1331 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01200]);
1332 }
1333
1334 // For each region, the aspectMask member of dstSubresource must be present in the destination image
1335 if (!VerifyAspectsPresent(regions[i].dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
1336 std::stringstream ss;
1337 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1338 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1339 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01201, "IMAGE", "%s. %s",
1340 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01201]);
1341 }
1342
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001343 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1344 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1345 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1346 std::stringstream ss;
1347 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1349 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1350 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1351 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001352
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001353 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1354 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1355 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1356 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1357 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1358 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1359 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1360 validation_error_map[VALIDATION_ERROR_01221]);
1361 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001362
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001363 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1364 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1365 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1366 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1367 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1368 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1369 std::stringstream ss;
1370 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1371 << "] baseArrayLayer was not zero or layerCount was not 1.";
1372 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1373 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1374 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1375 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001376
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001377 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1378 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1379 std::stringstream ss;
1380 ss << "vkCmdCopyImage: pRegions[" << i
1381 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1383 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1384 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1385 }
1386 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1387 std::stringstream ss;
1388 ss << "vkCmdCopyImage: pRegions[" << i
1389 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1390 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1391 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1392 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1393 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001394
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001395 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1396 // image was created
1397 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1398 src_image_state->createInfo.arrayLayers) {
1399 std::stringstream ss;
1400 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1401 << "] baseArrayLayer + layerCount is "
1402 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1403 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1404 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1405 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1406 }
1407 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1408 dst_image_state->createInfo.arrayLayers) {
1409 std::stringstream ss;
1410 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1411 << "] baseArrayLayer + layerCount is "
1412 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1414 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1415 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1416 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001417
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001418 // 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 -07001419 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &(src_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001420 std::stringstream ss;
1421 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1422 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1423 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1424 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1425 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001426
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001427 // 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 -07001428 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &(dst_image_state->createInfo.extent))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001429 std::stringstream ss;
1430 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1431 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1432 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1433 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1434 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001435
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001436 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1437 // must not overlap in memory
1438 if (src_image_state->image == dst_image_state->image) {
1439 for (uint32_t j = 0; j < region_count; j++) {
1440 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1441 std::stringstream ss;
1442 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1443 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1444 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1445 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001446 }
1447 }
1448 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001449 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001450
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001451 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1452 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1453 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1454 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1455 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1456 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1457 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1458 skip |=
1459 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1460 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1461 }
1462 } else {
1463 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1464 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1465 if (srcSize != destSize) {
1466 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1467 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1468 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1469 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001470 }
1471 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001472
Dave Houlton33c22b72017-02-28 13:16:02 -07001473 // Source and dest image sample counts must match
1474 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
1475 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
1476 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 -06001477 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01185, "IMAGE", "%s %s", str,
1478 validation_error_map[VALIDATION_ERROR_01185]);
Dave Houlton33c22b72017-02-28 13:16:02 -07001479 }
1480
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001481 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1482 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1483 // Validate that SRC & DST images have correct usage flags set
1484 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1485 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1486 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1487 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001488 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
1489 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_01193);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001490 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1491 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1492 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001493 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
1494 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_01180);
1495 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
1496 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_01183);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001497 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1498 "vkCmdCopyImage()");
1499 }
1500
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001501 return skip;
1502}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001503
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001504void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001505 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1506 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
1507 // Make sure that all image slices are updated to correct layout
1508 for (uint32_t i = 0; i < region_count; ++i) {
1509 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
1510 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
1511 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001512 // Update bindings between images and cmd buffer
1513 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1514 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07001515 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001516 cb_node->validate_functions.push_back(function);
1517 function = [=]() {
1518 SetImageMemoryValid(device_data, dst_image_state, true);
1519 return false;
1520 };
1521 cb_node->validate_functions.push_back(function);
1522 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1523}
1524
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001525// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1526// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1527// to that same cmd buffer by separate thread are not changing state from underneath us
1528// Track the last cmd buffer touched by this thread
1529static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1530 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1531 if (pCB->drawCount[i]) return true;
1532 }
1533 return false;
1534}
1535
1536// Returns true if sub_rect is entirely contained within rect
1537static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1538 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1539 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1540 return false;
1541 return true;
1542}
1543
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001544bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1545 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001546 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001547 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1548
1549 bool skip = false;
1550 if (cb_node) {
Mike Schuchardt9c582402017-02-23 15:57:37 -07001551 skip |=
1552 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_01121);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001553 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001554 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001555 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1556 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1557 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1558 // 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 -07001559 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
1560 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001561 skip |=
1562 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1563 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1564 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1565 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1566 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001567 }
1568 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1569 }
1570
1571 // Validate that attachment is in reference list of active subpass
1572 if (cb_node->activeRenderPass) {
1573 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1574 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001575 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001576
1577 for (uint32_t i = 0; i < attachmentCount; i++) {
1578 auto clear_desc = &pAttachments[i];
1579 VkImageView image_view = VK_NULL_HANDLE;
1580
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001581 if (0 == clear_desc->aspectMask) {
1582 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 -06001583 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001584 validation_error_map[VALIDATION_ERROR_01128]);
1585 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1586 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 -06001587 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001588 validation_error_map[VALIDATION_ERROR_01126]);
1589 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001590 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001591 skip |=
1592 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 -06001593 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01114, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001594 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1595 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001596 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1597 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001598 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer),
1599 __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001600 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1601 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001602 } else {
1603 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001604 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001605 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001606 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1607 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1608 char const str[] =
1609 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1610 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 -06001611 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001612 validation_error_map[VALIDATION_ERROR_01125]);
1613 }
1614 } else { // Must be depth and/or stencil
1615 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1616 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1617 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1618 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 -06001619 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001620 validation_error_map[VALIDATION_ERROR_01127]);
1621 }
1622 if (!subpass_desc->pDepthStencilAttachment ||
1623 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1624 skip |= log_msg(
1625 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001626 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001627 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001628 } else {
1629 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1630 }
1631 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001632 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001633 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001634 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001635 // The rectangular region specified by a given element of pRects must be contained within the render area of
1636 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001637 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
1638 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
1639 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001640 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1641 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01115, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001642 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1643 "the current render pass instance. %s",
1644 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001645 }
1646 // The layers specified by a given element of pRects must be contained within every attachment that
1647 // pAttachments refers to
1648 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1649 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1650 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1651 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001652 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1653 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01116, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001654 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1655 "pAttachment[%d]. %s",
1656 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001657 }
1658 }
1659 }
1660 }
1661 }
1662 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001663}
1664
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001665bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001666 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001667 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001668 bool skip = false;
1669 if (cb_node && src_image_state && dst_image_state) {
1670 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1671 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001672 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_01334);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001673 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1674 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001675
1676 // For each region, the number of layers in the image subresource should not be zero
1677 // For each region, src and dest image aspect must be color only
1678 for (uint32_t i = 0; i < regionCount; i++) {
1679 if (pRegions[i].srcSubresource.layerCount == 0) {
1680 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001681 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 -07001682 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1683 "IMAGE", str);
1684 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001685 if (pRegions[i].dstSubresource.layerCount == 0) {
1686 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001687 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 -07001688 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1689 "IMAGE", str);
1690 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001691 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1692 skip |= log_msg(
1693 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1694 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1695 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1696 validation_error_map[VALIDATION_ERROR_01339]);
1697 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001698 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1699 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1700 char const str[] =
1701 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1702 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1703 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1704 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1705 }
1706 }
1707
1708 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1709 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001710 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 -07001711 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1712 "IMAGE", str);
1713 }
1714 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1715 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001716 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 -07001717 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1718 str);
1719 }
1720 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1721 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1722 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1723 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1724 str, validation_error_map[VALIDATION_ERROR_01320]);
1725 }
1726 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1727 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1728 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1729 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1730 str, validation_error_map[VALIDATION_ERROR_01321]);
1731 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001732 } else {
1733 assert(0);
1734 }
1735 return skip;
1736}
1737
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001738void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1739 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001740 // Update bindings between images and cmd buffer
1741 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1742 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1743
1744 std::function<bool()> function = [=]() {
1745 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1746 };
1747 cb_node->validate_functions.push_back(function);
1748 function = [=]() {
1749 SetImageMemoryValid(device_data, dst_image_state, true);
1750 return false;
1751 };
1752 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001753 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001754}
1755
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001756bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001757 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1758 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1759
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001760 bool skip = false;
1761 if (cb_node && src_image_state && dst_image_state) {
1762 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001763 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001764 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001765 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001766 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1767 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1768 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001769 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001770 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001771 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001772 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_01299);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001773 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1774 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001775
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001776 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001777 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001778 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1779 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1780 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1781 std::stringstream ss;
1782 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1783 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1784 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1785 "%s", ss.str().c_str());
1786 }
1787 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1788 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1789 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1790 std::stringstream ss;
1791 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1792 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1793 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1794 "%s", ss.str().c_str());
1795 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001796 if (pRegions[i].srcSubresource.layerCount == 0) {
1797 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1798 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 -07001799 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1800 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001801 }
1802 if (pRegions[i].dstSubresource.layerCount == 0) {
1803 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1804 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 -07001805 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1806 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001807 }
1808
1809 // Check that src/dst layercounts match
1810 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1811 skip |=
1812 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1813 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1814 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1815 i, validation_error_map[VALIDATION_ERROR_01304]);
1816 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001817
1818 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1820 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1821 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1822 validation_error_map[VALIDATION_ERROR_01303]);
1823 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001824 }
1825
1826 VkFormat src_format = src_image_state->createInfo.format;
1827 VkFormat dst_format = dst_image_state->createInfo.format;
1828
1829 // Validate consistency for unsigned formats
1830 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1831 std::stringstream ss;
1832 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1833 << "the other one must also have unsigned integer format. "
1834 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1835 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1836 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1837 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1838 }
1839
1840 // Validate consistency for signed formats
1841 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1842 std::stringstream ss;
1843 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1844 << "the other one must also have signed integer format. "
1845 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << 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_02190, "IMAGE", "%s. %s",
1848 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1849 }
1850
1851 // Validate aspect bits and formats for depth/stencil images
1852 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
1853 if (src_format != dst_format) {
1854 std::stringstream ss;
1855 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1856 << "stencil, the other one must have exactly the same format. "
1857 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1858 << string_VkFormat(dst_format);
1859 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1860 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1861 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1862 }
1863
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001864 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001865 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001866
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001867 if (vk_format_is_depth_and_stencil(src_format)) {
1868 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1869 std::stringstream ss;
1870 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1871 "VK_IMAGE_ASPECT_DEPTH_BIT "
1872 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1873 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1874 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1875 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1876 }
1877 } else if (vk_format_is_stencil_only(src_format)) {
1878 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1879 std::stringstream ss;
1880 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1881 << "set in both the srcImage and dstImage";
1882 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1883 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1884 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1885 }
1886 } else if (vk_format_is_depth_only(src_format)) {
1887 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1888 std::stringstream ss;
1889 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1890 << "set in both the srcImage and dstImage";
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__,
1893 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1894 }
1895 }
1896 }
1897 }
1898
1899 // Validate filter
1900 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1901 std::stringstream ss;
1902 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1903 << "then filter must be VK_FILTER_NEAREST.";
1904 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1905 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1906 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1907 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001908 } else {
1909 assert(0);
1910 }
1911 return skip;
1912}
1913
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001914void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1915 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001916 // Update bindings between images and cmd buffer
1917 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1918 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1919
1920 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1921 cb_node->validate_functions.push_back(function);
1922 function = [=]() {
1923 SetImageMemoryValid(device_data, dst_image_state, true);
1924 return false;
1925 };
1926 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001927 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001928}
1929
Tony Barbourdf013b92017-01-25 12:53:48 -07001930// This validates that the initial layout specified in the command buffer for
1931// the IMAGE is the same
1932// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001933bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1934 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001935 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001936 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001937 for (auto cb_image_data : pCB->imageLayoutMap) {
1938 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001939
Jeremy Hayes55b6c292017-02-28 09:44:45 -07001940 if (FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001941 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1942 // TODO: Set memory invalid which is in mem_tracker currently
1943 } else if (imageLayout != cb_image_data.second.initialLayout) {
1944 if (cb_image_data.first.hasSubresource) {
Dave Houltoneba86e22017-03-02 14:56:23 -07001945 skip |= log_msg(
1946 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1947 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1948 "Cannot submit cmd buffer using image (0x%" PRIx64
1949 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1950 "with layout %s when first use is %s.",
1951 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
1952 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
1953 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001954 } else {
Dave Houltoneba86e22017-03-02 14:56:23 -07001955 skip |=
1956 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1957 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1958 "Cannot submit cmd buffer using image (0x%" PRIx64
1959 ") with layout %s when "
1960 "first use is %s.",
1961 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), string_VkImageLayout(imageLayout),
1962 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001963 }
1964 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001965 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001966 }
1967 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001968 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001969}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001970
Tony Barbourdf013b92017-01-25 12:53:48 -07001971void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1972 for (auto cb_image_data : pCB->imageLayoutMap) {
1973 VkImageLayout imageLayout;
1974 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1975 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1976 }
1977}
1978
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001979// Print readable FlagBits in FlagMask
1980static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1981 std::string result;
1982 std::string separator;
1983
1984 if (accessMask == 0) {
1985 result = "[None]";
1986 } else {
1987 result = "[";
1988 for (auto i = 0; i < 32; i++) {
1989 if (accessMask & (1 << i)) {
1990 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1991 separator = " | ";
1992 }
1993 }
1994 result = result + "]";
1995 }
1996 return result;
1997}
1998
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001999// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
2000// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002001// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002002static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2003 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2004 const char *type) {
2005 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2006 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002007
2008 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2009 if (accessMask & ~(required_bit | optional_bits)) {
2010 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002011 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2012 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002013 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2014 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002015 }
2016 } else {
2017 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002018 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2019 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002020 "%s AccessMask %d %s must contain at least one of access bits %d "
2021 "%s when layout is %s, unless the app has previously added a "
2022 "barrier for this transition.",
2023 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2024 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002025 } else {
2026 std::string opt_bits;
2027 if (optional_bits != 0) {
2028 std::stringstream ss;
2029 ss << optional_bits;
2030 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2031 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002032 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2033 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002034 "%s AccessMask %d %s must have required access bit %d %s %s when "
2035 "layout is %s, unless the app has previously added a barrier for "
2036 "this transition.",
2037 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2038 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002039 }
2040 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002041 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002042}
2043
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002044bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
2045 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
2046 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002047
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002048 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002049 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002050 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
2051 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
2052 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2053 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002054 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002055 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
2056 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
2057 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2058 break;
2059 }
2060 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
2061 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
2062 break;
2063 }
2064 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
2065 skip |= ValidateMaskBits(
2066 device_data, cmdBuffer, accessMask, layout, 0,
2067 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
2068 type);
2069 break;
2070 }
2071 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
2072 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
2073 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
2074 break;
2075 }
2076 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
2077 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
2078 break;
2079 }
2080 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
2081 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
2082 break;
2083 }
2084 case VK_IMAGE_LAYOUT_UNDEFINED: {
2085 if (accessMask != 0) {
2086 // TODO: Verify against Valid Use section spec
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002087 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2088 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002089 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2090 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
2091 }
2092 break;
2093 }
2094 case VK_IMAGE_LAYOUT_GENERAL:
2095 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002096 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002097 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002098}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002099
2100// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002101// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2102// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002103bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002104 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2105 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002106 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2107 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2108 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2109 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002110 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
2111 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
2112 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
2113 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002114 }
2115 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002116 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002117}
2118
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002119bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2120 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002121 bool skip = false;
2122
2123 // Track when we're observing the first use of an attachment
2124 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2125 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2126 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
2127 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2128 auto attach_index = subpass.pColorAttachments[j].attachment;
2129 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2130
2131 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002132 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
2133 // This is ideal.
2134 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002135
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002136 case VK_IMAGE_LAYOUT_GENERAL:
2137 // May not be optimal; TODO: reconsider this warning based on other constraints?
2138 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2139 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2140 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2141 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002142
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002143 default:
2144 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2145 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2146 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2147 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002148 }
2149
2150 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002151 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2152 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002153 }
2154 attach_first_use[attach_index] = false;
2155 }
2156 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2157 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002158 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2159 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2160 // These are ideal.
2161 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002162
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002163 case VK_IMAGE_LAYOUT_GENERAL:
2164 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2165 // doing a bunch of transitions.
2166 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2167 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2168 "GENERAL layout for depth attachment may not give optimal performance.");
2169 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002170
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002171 default:
2172 // No other layouts are acceptable
2173 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2174 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2175 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2176 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2177 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002178 }
2179
2180 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2181 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002182 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2183 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002184 }
2185 attach_first_use[attach_index] = false;
2186 }
2187 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2188 auto attach_index = subpass.pInputAttachments[j].attachment;
2189 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2190
2191 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002192 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2193 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2194 // These are ideal.
2195 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002196
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002197 case VK_IMAGE_LAYOUT_GENERAL:
2198 // May not be optimal. TODO: reconsider this warning based on other constraints.
2199 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2200 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2201 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2202 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002203
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002204 default:
2205 // No other layouts are acceptable
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002206 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2207 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002208 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2209 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002210 }
2211
2212 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002213 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2214 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002215 }
2216 attach_first_use[attach_index] = false;
2217 }
2218 }
2219 return skip;
2220}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002221
2222// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002223bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2224 VkDeviceSize offset, VkDeviceSize end_offset) {
2225 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2226 bool skip = false;
2227 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2228 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002229 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2230 for (auto image_handle : mem_info->bound_images) {
2231 auto img_it = mem_info->bound_ranges.find(image_handle);
2232 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002233 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002234 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002235 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002236 for (auto layout : layouts) {
2237 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002238 skip |= log_msg(
2239 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
2240 reinterpret_cast<const uint64_t &>(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2241 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2242 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
2243 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002244 }
2245 }
2246 }
2247 }
2248 }
2249 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002250 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002251}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002252
2253// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2254// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002255static 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 -07002256 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2257 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002258 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002259
2260 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002261 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002262 if (strict) {
2263 correct_usage = ((actual & desired) == desired);
2264 } else {
2265 correct_usage = ((actual & desired) != 0);
2266 }
2267 if (!correct_usage) {
2268 if (msgCode == -1) {
2269 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltoneba86e22017-03-02 14:56:23 -07002270 skip = log_msg(
2271 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2272 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation.",
2273 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002274 } else {
2275 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002276 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2277 "Invalid usage flag for %s 0x%" PRIxLEAST64
2278 " used by %s. In this case, %s should have %s set during creation. %s",
2279 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002280 }
2281 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002282 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002283}
2284
2285// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2286// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002287bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002288 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002289 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002290 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2291 msgCode, "image", func_name, usage_string);
2292}
2293
2294// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2295// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002296bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002297 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002298 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002299 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2300 msgCode, "buffer", func_name, usage_string);
2301}
2302
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002303bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002304 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002305 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2306
Mark Lobodzinski96210742017-02-09 10:33:46 -07002307 // TODO: Add check for VALIDATION_ERROR_00658
Mark Lobodzinski96210742017-02-09 10:33:46 -07002308 // TODO: Add check for VALIDATION_ERROR_00667
2309 // TODO: Add check for VALIDATION_ERROR_00668
2310 // TODO: Add check for VALIDATION_ERROR_00669
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002311
2312 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
2313 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2314 VALIDATION_ERROR_00666, "DS",
2315 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
2316 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
2317 validation_error_map[VALIDATION_ERROR_00666]);
2318 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06002319
2320 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
2321 skip |=
2322 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2323 DRAWSTATE_INVALID_FEATURE, "DS",
2324 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
2325 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
2326 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06002327
2328 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
2329 skip |=
2330 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2331 DRAWSTATE_INVALID_FEATURE, "DS",
2332 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
2333 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
2334 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07002335 return skip;
2336}
2337
2338void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2339 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2340 GetBufferMap(device_data)
2341 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2342}
2343
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002344bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2345 bool skip = false;
2346 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002347 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2348 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002349 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002350 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2351 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002352 skip |= ValidateBufferUsageFlags(
2353 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 -07002354 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2355 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002356 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002357}
2358
2359void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2360 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2361}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002362
2363// For the given format verify that the aspect masks make sense
2364bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2365 const char *func_name) {
2366 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2367 bool skip = false;
2368 if (vk_format_is_color(format)) {
2369 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2370 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2371 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2372 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2373 validation_error_map[VALIDATION_ERROR_00741]);
2374 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2375 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2376 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2377 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2378 validation_error_map[VALIDATION_ERROR_00741]);
2379 }
2380 } else if (vk_format_is_depth_and_stencil(format)) {
2381 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2383 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2384 "%s: Depth/stencil image formats must have "
2385 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2386 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2387 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2388 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_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: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2392 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2393 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2394 }
2395 } else if (vk_format_is_depth_only(format)) {
2396 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2397 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2398 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2399 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2400 validation_error_map[VALIDATION_ERROR_00741]);
2401 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2402 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2403 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2404 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2405 validation_error_map[VALIDATION_ERROR_00741]);
2406 }
2407 } else if (vk_format_is_stencil_only(format)) {
2408 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2410 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2411 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2412 validation_error_map[VALIDATION_ERROR_00741]);
2413 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2414 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2415 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2416 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2417 validation_error_map[VALIDATION_ERROR_00741]);
2418 }
2419 }
2420 return skip;
2421}
2422
2423bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2424 const char *func_name) {
2425 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2426 bool skip = false;
2427 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002428 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 -07002429 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2430 validation_error_map[VALIDATION_ERROR_00768]);
2431 }
2432 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002433 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 -07002434 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2435 validation_error_map[VALIDATION_ERROR_00769]);
2436 }
2437 return skip;
2438}
2439
2440bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2441 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2442 bool skip = false;
2443 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2444 if (image_state) {
2445 skip |= ValidateImageUsageFlags(
2446 device_data, image_state,
2447 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2448 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2449 false, -1, "vkCreateImageView()",
2450 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2451 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2452 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2453 // Checks imported from image layer
2454 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2455 std::stringstream ss;
2456 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2457 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2458 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002459 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 -07002460 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2461 }
2462 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2463 std::stringstream ss;
2464 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer << " for image "
2465 << create_info->image << " that only has " << image_state->createInfo.arrayLayers << " array layers.";
2466 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002467 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 -07002468 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00769]);
2469 }
2470 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2471 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2472
2473 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2474 VkFormat image_format = image_state->createInfo.format;
2475 VkFormat view_format = create_info->format;
2476 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2477
2478 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2479 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2480 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2481 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2482 std::stringstream ss;
2483 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2484 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2485 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2486 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002487 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 -07002488 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2489 validation_error_map[VALIDATION_ERROR_02171]);
2490 }
2491 } else {
2492 // Format MUST be IDENTICAL to the format the image was created with
2493 if (image_format != view_format) {
2494 std::stringstream ss;
2495 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2496 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2497 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002498 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 -07002499 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2500 validation_error_map[VALIDATION_ERROR_02172]);
2501 }
2502 }
2503
2504 // Validate correct image aspect bits for desired formats and format consistency
2505 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2506 }
2507 return skip;
2508}
2509
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002510void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2511 auto image_view_map = GetImageViewMap(device_data);
2512 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2513
2514 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002515 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002516 ResolveRemainingLevelsLayers(device_data, &sub_res_range, image_state);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002517}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002518
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002519bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2520 BUFFER_STATE *dst_buffer_state) {
2521 bool skip = false;
2522 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2523 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2524 // Validate that SRC & DST buffers have correct usage flags set
2525 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2526 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2527 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2528 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002529 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
2530 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_01171);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002531 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2532 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2533 return skip;
2534}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002535
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002536void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2537 BUFFER_STATE *dst_buffer_state) {
2538 // Update bindings between buffers and cmd buffer
2539 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2540 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2541
2542 std::function<bool()> function = [=]() {
2543 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2544 };
2545 cb_node->validate_functions.push_back(function);
2546 function = [=]() {
2547 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2548 return false;
2549 };
2550 cb_node->validate_functions.push_back(function);
2551 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2552}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002553
2554static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2555 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2556 bool skip = false;
2557 auto buffer_state = GetBufferState(device_data, buffer);
2558 if (!buffer_state) {
2559 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2560 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2561 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2562 } else {
2563 if (buffer_state->in_use.load()) {
2564 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2565 __LINE__, VALIDATION_ERROR_00676, "DS",
2566 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2567 validation_error_map[VALIDATION_ERROR_00676]);
2568 }
2569 }
2570 return skip;
2571}
2572
2573bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2574 VK_OBJECT *obj_struct) {
2575 *image_view_state = GetImageViewState(device_data, image_view);
2576 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2577 if (GetDisables(device_data)->destroy_image_view) return false;
2578 bool skip = false;
2579 if (*image_view_state) {
2580 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2581 }
2582 return skip;
2583}
2584
2585void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2586 VK_OBJECT obj_struct) {
2587 // Any bound cmd buffers are now invalid
2588 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2589 (*GetImageViewMap(device_data)).erase(image_view);
2590}
2591
2592bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2593 *buffer_state = GetBufferState(device_data, buffer);
2594 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2595 if (GetDisables(device_data)->destroy_buffer) return false;
2596 bool skip = false;
2597 if (*buffer_state) {
2598 skip |= validateIdleBuffer(device_data, buffer);
2599 }
2600 return skip;
2601}
2602
2603void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2604 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2605 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2606 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2607 if (mem_info) {
2608 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2609 }
2610 }
2611 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2612 GetBufferMap(device_data)->erase(buffer_state->buffer);
2613}
2614
2615bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2616 VK_OBJECT *obj_struct) {
2617 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2618 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2619 if (GetDisables(device_data)->destroy_buffer_view) return false;
2620 bool skip = false;
2621 if (*buffer_view_state) {
2622 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2623 }
2624 return skip;
2625}
2626
2627void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2628 VK_OBJECT obj_struct) {
2629 // Any bound cmd buffers are now invalid
2630 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2631 GetBufferViewMap(device_data)->erase(buffer_view);
2632}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002633
2634bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2635 bool skip = false;
2636 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
Mike Schuchardt9c582402017-02-23 15:57:37 -07002637 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
2638 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_01141);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002639 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2640 // Validate that DST buffer has correct usage flags set
2641 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2642 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2643 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2644 return skip;
2645}
2646
2647void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2648 std::function<bool()> function = [=]() {
2649 SetBufferMemoryValid(device_data, buffer_state, true);
2650 return false;
2651 };
2652 cb_node->validate_functions.push_back(function);
2653 // Update bindings between buffer and cmd buffer
2654 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2655 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2656}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002657
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002658bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2659 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002660 bool skip = false;
2661
2662 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002663 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
2664 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002665 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 -07002666 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
2667 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2668 "must be 0 and 1, respectively. %s",
2669 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2670 validation_error_map[VALIDATION_ERROR_01746]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002671 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002672 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002673
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002674 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
2675 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002676 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 -07002677 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
2678 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2679 "must be 0 and 1, respectively. %s",
2680 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2681 validation_error_map[VALIDATION_ERROR_01747]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002682 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002683 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002684
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002685 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2686 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2687 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2688 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
2689 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2690 "%d. For 3D images these must be 0 and 1, respectively. %s",
2691 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
2692 validation_error_map[VALIDATION_ERROR_01281]);
2693 }
2694 }
2695
2696 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2697 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
2698 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2699 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
2700 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2701 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2702 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
2703 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2704 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2705 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2706 }
2707
2708 // BufferOffset must be a multiple of 4
2709 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2710 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2711 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
2712 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2713 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2714 }
2715
2716 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2717 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2718 skip |= log_msg(
2719 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2720 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
2721 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2722 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2723 validation_error_map[VALIDATION_ERROR_01265]);
2724 }
2725
2726 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2727 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2728 skip |= log_msg(
2729 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2730 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
2731 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2732 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2733 validation_error_map[VALIDATION_ERROR_01266]);
2734 }
2735
2736 // subresource aspectMask must have exactly 1 bit set
2737 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2738 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2739 if (aspect_mask_bits.count() != 1) {
2740 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2741 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
2742 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2743 validation_error_map[VALIDATION_ERROR_01280]);
2744 }
2745
2746 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002747 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002748 skip |= log_msg(
2749 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2750 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
2751 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
2752 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
2753 validation_error_map[VALIDATION_ERROR_01279]);
2754 }
2755
2756 // Checks that apply only to compressed images
2757 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2758 // reserves a place for these compressed image checks. This block of code could move there once the image
2759 // stuff is moved into core validation.
2760 if (vk_format_is_compressed(image_state->createInfo.format)) {
2761 auto block_size = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2762
2763 // BufferRowLength must be a multiple of block width
2764 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002765 skip |= log_msg(
2766 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002767 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
2768 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2769 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002770 }
2771
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002772 // BufferRowHeight must be a multiple of block height
2773 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002774 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 -07002775 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
2776 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2777 "height (%d). %s.",
2778 function, i, pRegions[i].bufferImageHeight, block_size.height,
2779 validation_error_map[VALIDATION_ERROR_01272]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002780 }
2781
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002782 // image offsets must be multiples of block dimensions
2783 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
Dave Houlton75967fc2017-03-06 17:21:16 -07002784 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
2785 (vk_safe_modulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002786 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2787 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
2788 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2789 "width & height (%d, %d). %s.",
2790 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2791 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002792 }
2793
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002794 // bufferOffset must be a multiple of block size (linear bytes)
2795 size_t block_size_in_bytes = vk_format_get_size(image_state->createInfo.format);
2796 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
2797 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2798 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01274, "IMAGE",
2799 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
2800 ") must be a multiple of the compressed image's texel block "
2801 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
2802 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2803 validation_error_map[VALIDATION_ERROR_01274]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002804 }
Dave Houlton67e9b532017-03-02 17:00:10 -07002805
2806 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07002807 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton67e9b532017-03-02 17:00:10 -07002808 if ((vk_safe_modulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002809 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
2810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2811 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01275, "IMAGE",
2812 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
2813 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
2814 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
2815 mip_extent.width, validation_error_map[VALIDATION_ERROR_01275]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002816 }
2817
2818 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
2819 if ((vk_safe_modulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002820 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
2821 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2822 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01276, "IMAGE",
2823 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
2824 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
2825 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
2826 mip_extent.height, validation_error_map[VALIDATION_ERROR_01276]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002827 }
2828
2829 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
2830 if ((vk_safe_modulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002831 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
2832 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2833 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01277, "IMAGE",
2834 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
2835 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
2836 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
2837 mip_extent.depth, validation_error_map[VALIDATION_ERROR_01277]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002838 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002839 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002840 }
2841
2842 return skip;
2843}
2844
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002845static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
2846 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002847 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002848 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002849
2850 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002851 VkExtent3D extent = pRegions[i].imageExtent;
2852 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002853
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002854 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
2855 {
2856 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2857 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
2858 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
2859 extent.height, extent.depth);
2860 }
2861
2862 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
2863
2864 // 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 -07002865 if (vk_format_is_compressed(image_info->format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002866 auto block_extent = vk_format_compressed_texel_block_extents(image_info->format);
2867 if (image_extent.width % block_extent.width) {
2868 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
2869 }
2870 if (image_extent.height % block_extent.height) {
2871 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
2872 }
2873 if (image_extent.depth % block_extent.depth) {
2874 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
2875 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002876 }
2877
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002878 if (ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002879 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 -07002880 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002881 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002882 }
2883 }
2884
2885 return skip;
2886}
2887
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002888static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2889 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2890 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2891 bool skip = false;
2892
2893 VkDeviceSize buffer_size = buff_state->createInfo.size;
2894
2895 for (uint32_t i = 0; i < regionCount; i++) {
2896 VkExtent3D copy_extent = pRegions[i].imageExtent;
2897
2898 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2899 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2900 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2901
Dave Houltonf3229d52017-02-21 15:59:08 -07002902 // Handle special buffer packing rules for specific depth/stencil formats
2903 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2904 unit_size = vk_format_get_size(VK_FORMAT_S8_UINT);
2905 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2906 switch (image_state->createInfo.format) {
2907 case VK_FORMAT_D16_UNORM_S8_UINT:
2908 unit_size = vk_format_get_size(VK_FORMAT_D16_UNORM);
2909 break;
2910 case VK_FORMAT_D32_SFLOAT_S8_UINT:
2911 unit_size = vk_format_get_size(VK_FORMAT_D32_SFLOAT);
2912 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002913 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07002914 case VK_FORMAT_D24_UNORM_S8_UINT:
2915 unit_size = 4;
2916 break;
2917 default:
2918 break;
2919 }
2920 }
2921
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002922 if (vk_format_is_compressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002923 // Switch to texel block units, rounding up for any partially-used blocks
2924 auto block_dim = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2925 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
2926 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
2927
2928 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
2929 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
2930 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002931 }
2932
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002933 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
2934 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2935 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
2936 // TODO: Issure warning here? Already warned in ValidateImageBounds()...
2937 } else {
2938 // Calculate buffer offset of final copied byte, + 1.
2939 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
2940 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2941 max_buffer_offset *= unit_size; // convert to bytes
2942 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002943
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002944 if (buffer_size < max_buffer_offset) {
2945 skip |=
2946 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2947 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
2948 i, buffer_size, validation_error_map[msg_code]);
2949 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002950 }
2951 }
2952
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002953 return skip;
2954}
2955
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002956bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002957 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002958 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002959 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2960 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2961
2962 // Validate command buffer state
2963 if (CB_RECORDING != cb_node->state) {
2964 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2965 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2966 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2967 validation_error_map[VALIDATION_ERROR_01258]);
2968 } else {
2969 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2970 }
2971
2972 // Command pool must support graphics, compute, or transfer operations
2973 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2974
2975 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2976 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2977 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2978 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2979 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2980 "or transfer capabilities. %s.",
2981 validation_error_map[VALIDATION_ERROR_01259]);
2982 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002983 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002984 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002985 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002986 VALIDATION_ERROR_01246);
2987
2988 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2989 VALIDATION_ERROR_01249);
2990 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002991 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002992
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002993 // Validate that SRC image & DST buffer have correct usage flags set
2994 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2995 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002996 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002997 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002998 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
2999 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003000 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
3001 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01251);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003002 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003003 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003004 }
3005 return skip;
3006}
3007
3008void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003009 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
3010 VkImageLayout src_image_layout) {
3011 // Make sure that all image slices are updated to correct layout
3012 for (uint32_t i = 0; i < region_count; ++i) {
3013 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
3014 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003015 // Update bindings between buffer/image and cmd buffer
3016 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003017 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003018
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003019 std::function<bool()> function = [=]() {
3020 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
3021 };
3022 cb_node->validate_functions.push_back(function);
3023 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003024 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003025 return false;
3026 };
3027 cb_node->validate_functions.push_back(function);
3028
3029 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003030}
3031
3032bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003033 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003034 const VkBufferImageCopy *pRegions, const char *func_name) {
3035 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3036 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
3037
3038 // Validate command buffer state
3039 if (CB_RECORDING != cb_node->state) {
3040 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3041 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
3042 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
3043 validation_error_map[VALIDATION_ERROR_01240]);
3044 } else {
3045 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
3046 }
3047
3048 // Command pool must support graphics, compute, or transfer operations
3049 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3050 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3051 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3053 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
3054 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
3055 "or transfer capabilities. %s.",
3056 validation_error_map[VALIDATION_ERROR_01241]);
3057 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003058 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003059 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003060 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003061 VALIDATION_ERROR_01227);
3062 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
3063 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003064 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003065 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003066 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003067 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3068 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
3069 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003070 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
3071 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003072 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
3073 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01234);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003074 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
3075 "vkCmdCopyBufferToImage()");
3076 }
3077 return skip;
3078}
3079
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003080void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003081 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
3082 VkImageLayout dst_image_layout) {
3083 // Make sure that all image slices are updated to correct layout
3084 for (uint32_t i = 0; i < region_count; ++i) {
3085 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
3086 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003087 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003088 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003089 std::function<bool()> function = [=]() {
3090 SetImageMemoryValid(device_data, dst_image_state, true);
3091 return false;
3092 };
3093 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003094 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003095 cb_node->validate_functions.push_back(function);
3096
3097 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003098}
Mike Weiblen672b58b2017-02-21 14:32:53 -07003099
3100bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
3101 const auto report_data = core_validation::GetReportData(device_data);
3102 bool skip = false;
3103 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
3104
3105 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
3106 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
3107 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
3108 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003109 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3110 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00733, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003111 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
3112 validation_error_map[VALIDATION_ERROR_00733]);
3113 }
3114
3115 IMAGE_STATE *image_entry = GetImageState(device_data, image);
3116 if (!image_entry) {
3117 return skip;
3118 }
3119
3120 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
3121 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003122 skip |= 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_00732, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003124 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
3125 validation_error_map[VALIDATION_ERROR_00732]);
3126 }
3127
3128 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
3129 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003130 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3131 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00739, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003132 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
3133 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
3134 }
3135
3136 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
3137 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003138 skip |=
3139 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3140 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00740, "IMAGE",
3141 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
3142 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003143 }
3144
3145 // VU 00741: subresource's aspect must be compatible with image's format.
3146 const VkFormat img_format = image_entry->createInfo.format;
3147 if (vk_format_is_color(img_format)) {
3148 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
3149 skip |= log_msg(
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003150 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3151 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00741, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003152 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
3153 validation_error_map[VALIDATION_ERROR_00741]);
3154 }
3155 } else if (vk_format_is_depth_or_stencil(img_format)) {
3156 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003157 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3158 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00741, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003159 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
3160 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
3161 validation_error_map[VALIDATION_ERROR_00741]);
3162 }
3163 }
3164 return skip;
3165}