blob: 9685dfba2ef3019d8f1d988eed62e05f3ad3f71f [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;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700471
Mike Weiblen62d08a32017-03-07 22:18:27 -0700472 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
473 auto img_barrier = &pImageMemoryBarriers[i];
474 if (!img_barrier) continue;
475
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600476 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, img_barrier->image)->createInfo);
477 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
478 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700479
Mike Weiblen62d08a32017-03-07 22:18:27 -0700480 for (uint32_t j = 0; j < level_count; j++) {
481 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
482 for (uint32_t k = 0; k < layer_count; k++) {
483 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
484 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
485 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
486 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
487 skip |= ValidateImageAspectLayout(device_data, pCB, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700488 }
489 }
Mike Weiblen62d08a32017-03-07 22:18:27 -0700490
491 IMAGE_STATE *image_state = GetImageState(device_data, img_barrier->image);
492 if (image_state) {
493 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
494 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
495 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
496 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700497 }
498 return skip;
499}
500
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700501void TransitionImageLayouts(layer_data *device_data, VkCommandBuffer cmdBuffer, uint32_t memBarrierCount,
502 const VkImageMemoryBarrier *pImgMemBarriers) {
503 GLOBAL_CB_NODE *pCB = GetCBNode(device_data, cmdBuffer);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700504
505 for (uint32_t i = 0; i < memBarrierCount; ++i) {
506 auto mem_barrier = &pImgMemBarriers[i];
507 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700508
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600509 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, mem_barrier->image)->createInfo);
510 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
511 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
512
513 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700514 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600515 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700516 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
517 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
518 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
519 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
520 TransitionImageAspectLayout(device_data, pCB, mem_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
521 }
522 }
523 }
524}
525
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600526bool VerifyImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
527 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600528 const char *caller, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700529 const auto report_data = core_validation::GetReportData(device_data);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600530 const auto image = image_state->image;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700531 bool skip_call = false;
532
533 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
534 uint32_t layer = i + subLayers.baseArrayLayer;
535 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
536 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600537 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
538 if (node.layout != explicit_layout) {
539 // TODO: Improve log message in the next pass
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600540 skip_call |=
541 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
542 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600543 "%s: Cannot use image 0x%" PRIxLEAST64
544 " with specific layout %s that doesn't match the actual current layout %s.",
545 caller, reinterpret_cast<const uint64_t &>(image), string_VkImageLayout(explicit_layout),
546 string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600547 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700548 }
549 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -0600550 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
551 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
552 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700553 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
554 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600555 skip_call |= log_msg(
556 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
557 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
558 "%s: For optimal performance image 0x%" PRIxLEAST64 " layout should be %s instead of GENERAL.", caller,
559 reinterpret_cast<const uint64_t &>(image), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700560 }
561 } else {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600562 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
563 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, msg_code, "DS",
Mark Lobodzinski91c28262017-03-22 13:06:12 -0600564 "%s: Layout for image 0x%" PRIxLEAST64 " is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL. %s",
565 caller, reinterpret_cast<const uint64_t &>(image), string_VkImageLayout(explicit_layout),
566 string_VkImageLayout(optimal_layout), validation_error_map[msg_code]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567 }
568 }
569 return skip_call;
570}
571
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700572void TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
573 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700574 auto renderPass = GetRenderPassState(device_data, pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 if (!renderPass) return;
576
577 const VkRenderPassCreateInfo *pRenderPassInfo = renderPass->createInfo.ptr();
578 if (framebuffer_state) {
579 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
580 auto image_view = framebuffer_state->createInfo.pAttachments[i];
581 SetImageViewLayout(device_data, pCB, image_view, pRenderPassInfo->pAttachments[i].finalLayout);
582 }
583 }
584}
585
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700586bool PreCallValidateCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700587 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
588 bool skip_call = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700589 const debug_report_data *report_data = core_validation::GetReportData(device_data);
590
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600591 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700592 skip_call |=
593 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
594 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
595 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes96dcd812017-03-14 14:04:19 -0600596
597 return skip_call;
598 }
599
600 const VkFormatProperties *properties = GetFormatProperties(device_data, pCreateInfo->format);
601
602 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties->linearTilingFeatures == 0)) {
603 std::stringstream ss;
604 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
605 skip_call |=
606 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
607 VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02150]);
608
609 return skip_call;
610 }
611
612 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties->optimalTilingFeatures == 0)) {
613 std::stringstream ss;
614 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
615 skip_call |=
616 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
617 VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02155]);
618
619 return skip_call;
620 }
621
622 // Validate that format supports usage as color attachment
623 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
624 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
625 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
626 std::stringstream ss;
627 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
628 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
629 skip_call |=
630 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
631 VALIDATION_ERROR_02158, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
632 }
633 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
634 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
635 std::stringstream ss;
636 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
637 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
638 skip_call |=
639 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
640 VALIDATION_ERROR_02153, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
641 }
642 }
643
644 // Validate that format supports usage as depth/stencil attachment
645 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
646 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
647 ((properties->optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
648 std::stringstream ss;
649 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
650 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
651 skip_call |=
652 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
653 VALIDATION_ERROR_02159, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
654 }
655 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
656 ((properties->linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
657 std::stringstream ss;
658 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
659 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
660 skip_call |=
661 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
662 VALIDATION_ERROR_02154, "IMAGE", "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
663 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700664 }
665
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700666 const VkImageFormatProperties *ImageFormatProperties = GetImageFormatProperties(
667 device_data, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700668
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700669 VkDeviceSize imageGranularity = GetPhysicalDeviceProperties(device_data)->limits.bufferImageGranularity;
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700670 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
671
Mark Lobodzinski688ed322017-01-27 11:13:21 -0700672 if ((pCreateInfo->extent.width <= 0) || (pCreateInfo->extent.height <= 0) || (pCreateInfo->extent.depth <= 0)) {
673 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
674 VALIDATION_ERROR_00716, "Image",
675 "CreateImage extent is 0 for at least one required dimension for image: "
676 "Width = %d Height = %d Depth = %d. %s",
677 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
678 validation_error_map[VALIDATION_ERROR_00716]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700679 }
680
681 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
682 // All these extent-related VUs should be checked here
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700683 if ((pCreateInfo->extent.depth > ImageFormatProperties->maxExtent.depth) ||
684 (pCreateInfo->extent.width > ImageFormatProperties->maxExtent.width) ||
685 (pCreateInfo->extent.height > ImageFormatProperties->maxExtent.height)) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700686 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
687 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
688 "CreateImage extents exceed allowable limits for format: "
689 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
690 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700691 ImageFormatProperties->maxExtent.width, ImageFormatProperties->maxExtent.height,
692 ImageFormatProperties->maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700693 }
694
695 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
696 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
697 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
698 (uint64_t)imageGranularity) &
699 ~(uint64_t)imageGranularity;
700
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700701 if (totalSize > ImageFormatProperties->maxResourceSize) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700702 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
703 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
704 "CreateImage resource size exceeds allowable maximum "
705 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700706 totalSize, ImageFormatProperties->maxResourceSize);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700707 }
708
709 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700710 if (pCreateInfo->mipLevels > ImageFormatProperties->maxMipLevels) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700711 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
712 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
713 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700714 ImageFormatProperties->maxMipLevels);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700715 }
716
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700717 if (pCreateInfo->arrayLayers > ImageFormatProperties->maxArrayLayers) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700718 skip_call |= log_msg(
719 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__, VALIDATION_ERROR_02133,
720 "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s", pCreateInfo->arrayLayers,
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700721 ImageFormatProperties->maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700722 }
723
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700724 if ((pCreateInfo->samples & ImageFormatProperties->sampleCounts) == 0) {
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700725 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
726 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -0700727 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties->sampleCounts,
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700728 validation_error_map[VALIDATION_ERROR_02138]);
729 }
730
731 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
732 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
733 VALIDATION_ERROR_00731, "Image",
734 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
735 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
736 validation_error_map[VALIDATION_ERROR_00731]);
737 }
738
Mark Lobodzinski847b60c2017-03-13 09:32:45 -0600739 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
740 skip_call |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
741 VALIDATION_ERROR_02143, "DS",
742 "vkCreateImage(): the sparseBinding device feature is disabled: Images cannot be created with the "
743 "VK_IMAGE_CREATE_SPARSE_BINDING_BIT set. %s",
744 validation_error_map[VALIDATION_ERROR_02143]);
745 }
746
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -0600747 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
748 skip_call |=
749 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
750 DRAWSTATE_INVALID_FEATURE, "DS",
751 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
752 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
753 }
754
Mark Lobodzinski90224de2017-01-26 15:23:11 -0700755 return skip_call;
756}
757
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700758void PostCallRecordCreateImage(layer_data *device_data, const VkImageCreateInfo *pCreateInfo, VkImage *pImage) {
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700759 IMAGE_LAYOUT_NODE image_state;
760 image_state.layout = pCreateInfo->initialLayout;
761 image_state.format = pCreateInfo->format;
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700762 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(new IMAGE_STATE(*pImage, pCreateInfo))));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700763 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski214144a2017-01-27 14:25:32 -0700764 (*core_validation::GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
765 (*core_validation::GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -0700766}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700767
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700768bool PreCallValidateDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE **image_state, VK_OBJECT *obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700769 const CHECK_DISABLED *disabled = core_validation::GetDisables(device_data);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700770 *image_state = core_validation::GetImageState(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700771 *obj_struct = {reinterpret_cast<uint64_t &>(image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT};
772 if (disabled->destroy_image) return false;
773 bool skip = false;
774 if (*image_state) {
775 skip |= core_validation::ValidateObjectNotInUse(device_data, *image_state, *obj_struct, VALIDATION_ERROR_00743);
776 }
777 return skip;
778}
779
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700780void PostCallRecordDestroyImage(layer_data *device_data, VkImage image, IMAGE_STATE *image_state, VK_OBJECT obj_struct) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700781 core_validation::invalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
782 // Clean up memory mapping, bindings and range references for image
783 for (auto mem_binding : image_state->GetBoundMemory()) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700784 auto mem_info = core_validation::GetMemObjInfo(device_data, mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -0700785 if (mem_info) {
786 core_validation::RemoveImageMemoryRange(obj_struct.handle, mem_info);
787 }
788 }
789 core_validation::ClearMemoryObjectBindings(device_data, obj_struct.handle, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT);
790 // Remove image from imageMap
791 core_validation::GetImageMap(device_data)->erase(image);
792 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap =
793 core_validation::GetImageSubresourceMap(device_data);
794
795 const auto &sub_entry = imageSubresourceMap->find(image);
796 if (sub_entry != imageSubresourceMap->end()) {
797 for (const auto &pair : sub_entry->second) {
798 core_validation::GetImageLayoutMap(device_data)->erase(pair);
799 }
800 imageSubresourceMap->erase(sub_entry);
801 }
802}
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700803
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700804bool ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -0700805 bool skip = false;
806 const debug_report_data *report_data = core_validation::GetReportData(device_data);
807
808 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
809 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
811 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
812 }
813
814 if (vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
815 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
816 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
817 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
818 validation_error_map[VALIDATION_ERROR_01088]);
819 } else if (vk_format_is_compressed(image_state->createInfo.format)) {
820 char const str[] = "vkCmdClearColorImage called with compressed image.";
821 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
822 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
823 validation_error_map[VALIDATION_ERROR_01088]);
824 }
825
826 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
827 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
829 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
830 validation_error_map[VALIDATION_ERROR_01084]);
831 }
832 return skip;
833}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700834
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600835uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
836 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
837 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700838 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600839 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700840 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600841 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700842}
843
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600844uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
845 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
846 uint32_t array_layer_count = range->layerCount;
847 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
848 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700849 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600850 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700851}
852
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700853bool VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700854 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
855 bool skip = false;
856 const debug_report_data *report_data = core_validation::GetReportData(device_data);
857
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600858 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
859 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700860
861 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
862 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700863 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
864 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600865 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
866 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700867 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
868 }
869 } else {
870 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01086;
871 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
872 error_code = VALIDATION_ERROR_01101;
873 } else {
874 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
875 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -0600876 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
877 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, error_code, "DS",
878 "%s: Layout for cleared image is %s but can only be "
879 "TRANSFER_DST_OPTIMAL or GENERAL. %s",
880 func_name, string_VkImageLayout(dest_image_layout), validation_error_map[error_code]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700881 }
882 }
883
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600884 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
885 uint32_t level = level_index + range.baseMipLevel;
886 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
887 uint32_t layer = layer_index + range.baseArrayLayer;
888 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700889 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700890 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700891 if (node.layout != dest_image_layout) {
892 UNIQUE_VALIDATION_ERROR_CODE error_code = VALIDATION_ERROR_01085;
893 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
894 error_code = VALIDATION_ERROR_01100;
895 } else {
896 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
897 }
898 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
899 __LINE__, error_code, "DS",
900 "%s: Cannot clear an image whose layout is %s and "
901 "doesn't match the current layout %s. %s",
902 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout),
903 validation_error_map[error_code]);
904 }
905 }
906 }
907 }
908
909 return skip;
910}
911
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700912void RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image, VkImageSubresourceRange range,
913 VkImageLayout dest_image_layout) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600914 VkImageCreateInfo *image_create_info = &(GetImageState(device_data, image)->createInfo);
915 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
916 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700917
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600918 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
919 uint32_t level = level_index + range.baseMipLevel;
920 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
921 uint32_t layer = layer_index + range.baseArrayLayer;
922 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700923 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700924 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
925 SetLayout(device_data, cb_node, image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(dest_image_layout, dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700926 }
927 }
928 }
929}
930
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700931bool PreCallValidateCmdClearColorImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700932 VkImageLayout imageLayout, uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
933 bool skip = false;
934 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700935 auto cb_node = GetCBNode(dev_data, commandBuffer);
936 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700937 if (cb_node && image_state) {
938 skip |= ValidateMemoryIsBoundToImage(dev_data, image_state, "vkCmdClearColorImage()", VALIDATION_ERROR_02527);
Mike Schuchardt9c582402017-02-23 15:57:37 -0700939 skip |= ValidateCmdQueueFlags(dev_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
940 VALIDATION_ERROR_01095);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700941 skip |= ValidateCmd(dev_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
942 skip |= insideRenderPass(dev_data, cb_node, "vkCmdClearColorImage()", VALIDATION_ERROR_01096);
943 for (uint32_t i = 0; i < rangeCount; ++i) {
944 skip |= ValidateImageAttributes(dev_data, image_state, pRanges[i]);
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700945 skip |= VerifyClearImageLayout(dev_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700946 }
947 }
948 return skip;
949}
950
951// This state recording routine is shared between ClearColorImage and ClearDepthStencilImage
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700952void PreCallRecordCmdClearImage(layer_data *dev_data, VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
953 uint32_t rangeCount, const VkImageSubresourceRange *pRanges, CMD_TYPE cmd_type) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700954 auto cb_node = GetCBNode(dev_data, commandBuffer);
955 auto image_state = GetImageState(dev_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700956 if (cb_node && image_state) {
957 AddCommandBufferBindingImage(dev_data, cb_node, image_state);
958 std::function<bool()> function = [=]() {
959 SetImageMemoryValid(dev_data, image_state, true);
960 return false;
961 };
962 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700963 core_validation::UpdateCmdBufferLastCmd(cb_node, cmd_type);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700964 for (uint32_t i = 0; i < rangeCount; ++i) {
965 RecordClearImageLayout(dev_data, cb_node, image, pRanges[i], imageLayout);
966 }
967 }
968}
969
Tobin Ehlis58c884f2017-02-08 12:15:27 -0700970bool PreCallValidateCmdClearDepthStencilImage(layer_data *device_data, VkCommandBuffer commandBuffer, VkImage image,
971 VkImageLayout imageLayout, uint32_t rangeCount,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700972 const VkImageSubresourceRange *pRanges) {
973 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700974 const debug_report_data *report_data = core_validation::GetReportData(device_data);
975
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700976 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -0700977 auto cb_node = GetCBNode(device_data, commandBuffer);
978 auto image_state = GetImageState(device_data, image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700979 if (cb_node && image_state) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700980 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_02528);
Mike Schuchardt9c582402017-02-23 15:57:37 -0700981 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
982 VALIDATION_ERROR_01110);
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700983 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
984 skip |= insideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", VALIDATION_ERROR_01111);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -0700985 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -0700986 skip |=
987 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -0700988 // Image aspect must be depth or stencil or both
989 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
990 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
991 char const str[] =
992 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
993 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
994 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
995 (uint64_t)commandBuffer, __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", str);
996 }
997 }
998 if (image_state && !vk_format_is_depth_or_stencil(image_state->createInfo.format)) {
999 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
1000 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1001 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
1002 validation_error_map[VALIDATION_ERROR_01103]);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001003 }
1004 }
1005 return skip;
1006}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001007
1008// Returns true if [x, xoffset] and [y, yoffset] overlap
1009static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1010 bool result = false;
1011 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1012 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1013
1014 if (intersection_max > intersection_min) {
1015 result = true;
1016 }
1017 return result;
1018}
1019
1020// Returns true if two VkImageCopy structures overlap
1021static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
1022 bool result = false;
1023 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
1024 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
1025 dst->dstSubresource.layerCount))) {
1026 result = true;
1027 switch (type) {
1028 case VK_IMAGE_TYPE_3D:
1029 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
1030 // Intentionally fall through to 2D case
1031 case VK_IMAGE_TYPE_2D:
1032 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
1033 // Intentionally fall through to 1D case
1034 case VK_IMAGE_TYPE_1D:
1035 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
1036 break;
1037 default:
1038 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1039 assert(false);
1040 }
1041 }
1042 return result;
1043}
1044
1045// Returns true if offset and extent exceed image extents
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001046static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001047 bool result = false;
1048 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001049 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1050 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
1051 result = true;
1052 }
1053 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1054 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
1055 result = true;
1056 }
1057 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1058 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
1059 result = true;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001060 }
1061 return result;
1062}
1063
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001064// Test if two VkExtent3D structs are equivalent
1065static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1066 bool result = true;
1067 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1068 (extent->depth != other_extent->depth)) {
1069 result = false;
1070 }
1071 return result;
1072}
1073
1074// Returns the image extent of a specific subresource.
1075static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1076 const uint32_t mip = subresource->mipLevel;
1077 VkExtent3D extent = img->createInfo.extent;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001078 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
1079 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1080 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1081 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001082 return extent;
1083}
1084
1085// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001086static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001087 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1088}
1089
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001090// Test if the extent argument has any dimensions set to 0.
1091static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1092 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1093}
1094
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001095// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
1096static inline VkExtent3D GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
1097 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1098 VkExtent3D granularity = {0, 0, 0};
1099 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
1100 if (pPool) {
1101 granularity =
1102 GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
1103 if (vk_format_is_compressed(img->createInfo.format)) {
Mark Lobodzinski13086442017-02-24 08:53:14 -07001104 auto block_size = vk_format_compressed_texel_block_extents(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001105 granularity.width *= block_size.width;
1106 granularity.height *= block_size.height;
1107 }
1108 }
1109 return granularity;
1110}
1111
1112// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1113static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1114 bool valid = true;
1115 if ((vk_safe_modulo(extent->depth, granularity->depth) != 0) || (vk_safe_modulo(extent->width, granularity->width) != 0) ||
1116 (vk_safe_modulo(extent->height, granularity->height) != 0)) {
1117 valid = false;
1118 }
1119 return valid;
1120}
1121
1122// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
1123static inline bool CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1124 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member) {
1125 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1126 bool skip = false;
1127 VkExtent3D offset_extent = {};
1128 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1129 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1130 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001131 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001132 // 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 -07001133 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001134 skip |=
1135 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1136 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1137 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) "
1138 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1139 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001140 }
1141 } else {
1142 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1143 // integer multiples of the image transfer granularity.
1144 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001145 skip |= log_msg(
1146 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1147 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1148 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer "
1149 "multiples of this command buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1150 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height, granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001151 }
1152 }
1153 return skip;
1154}
1155
1156// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
1157static inline bool CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1158 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1159 const uint32_t i, const char *function, const char *member) {
1160 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1161 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001162 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001163 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1164 // subresource extent.
1165 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001166 skip |=
1167 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1168 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
1169 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1170 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1171 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1172 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001173 }
1174 } else {
1175 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1176 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1177 // subresource extent dimensions.
1178 VkExtent3D offset_extent_sum = {};
1179 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1180 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1181 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
1182 if ((IsExtentAligned(extent, granularity) == false) && (IsExtentEqual(&offset_extent_sum, subresource_extent) == false)) {
1183 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001184 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1185 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001186 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command buffer's "
1187 "queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1188 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1189 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
1190 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
1191 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
1192 }
1193 }
1194 return skip;
1195}
1196
1197// Check a uint32_t width or stride value against a queue family's Image Transfer Granularity width value
1198static inline bool CheckItgInt(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const uint32_t value,
1199 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1200 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1201
1202 bool skip = false;
1203 if (vk_safe_modulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001204 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1205 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001206 "%s: pRegion[%d].%s (%d) must be an even integer multiple of this command buffer's queue family image "
1207 "transfer granularity width (%d).",
1208 function, i, member, value, granularity);
1209 }
1210 return skip;
1211}
1212
1213// Check a VkDeviceSize value against a queue family's Image Transfer Granularity width value
1214static inline bool CheckItgSize(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkDeviceSize value,
1215 const uint32_t granularity, const uint32_t i, const char *function, const char *member) {
1216 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1217 bool skip = false;
1218 if (vk_safe_modulo(value, granularity) != 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001219 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1220 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_IMAGE_TRANSFER_GRANULARITY, "DS",
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001221 "%s: pRegion[%d].%s (%" PRIdLEAST64
1222 ") must be an even integer multiple of this command buffer's queue family image transfer "
1223 "granularity width (%d).",
1224 function, i, member, value, granularity);
1225 }
1226 return skip;
1227}
1228
1229// Check valid usage Image Tranfer Granularity requirements for elements of a VkBufferImageCopy structure
1230bool ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1231 const IMAGE_STATE *img, const VkBufferImageCopy *region,
1232 const uint32_t i, const char *function) {
1233 bool skip = false;
1234 if (vk_format_is_compressed(img->createInfo.format) == true) {
1235 // TODO: Add granularity checking for compressed formats
1236
1237 // bufferRowLength must be a multiple of the compressed texel block width
1238 // bufferImageHeight must be a multiple of the compressed texel block height
1239 // all members of imageOffset must be a multiple of the corresponding dimensions of the compressed texel block
1240 // bufferOffset must be a multiple of the compressed texel block size in bytes
1241 // imageExtent.width must be a multiple of the compressed texel block width or (imageExtent.width + imageOffset.x)
1242 // must equal the image subresource width
1243 // imageExtent.height must be a multiple of the compressed texel block height or (imageExtent.height + imageOffset.y)
1244 // must equal the image subresource height
1245 // imageExtent.depth must be a multiple of the compressed texel block depth or (imageExtent.depth + imageOffset.z)
1246 // must equal the image subresource depth
1247 } else {
1248 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1249 skip |= CheckItgSize(device_data, cb_node, region->bufferOffset, granularity.width, i, function, "bufferOffset");
1250 skip |= CheckItgInt(device_data, cb_node, region->bufferRowLength, granularity.width, i, function, "bufferRowLength");
1251 skip |= CheckItgInt(device_data, cb_node, region->bufferImageHeight, granularity.width, i, function, "bufferImageHeight");
1252 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset");
1253 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
1254 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
1255 i, function, "imageExtent");
1256 }
1257 return skip;
1258}
1259
1260// Check valid usage Image Tranfer Granularity requirements for elements of a VkImageCopy structure
1261bool ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
1262 const IMAGE_STATE *img, const VkImageCopy *region, const uint32_t i,
1263 const char *function) {
1264 bool skip = false;
1265 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
1266 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset");
1267 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset");
1268 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->dstSubresource);
1269 skip |= CheckItgExtent(device_data, cb_node, &region->extent, &region->dstOffset, &granularity, &subresource_extent, i,
1270 function, "extent");
1271 return skip;
1272}
1273
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001274bool PreCallValidateCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001275 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1276 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001277 bool skip = false;
1278 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1279 VkCommandBuffer command_buffer = cb_node->commandBuffer;
1280
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001281 for (uint32_t i = 0; i < region_count; i++) {
1282 if (regions[i].srcSubresource.layerCount == 0) {
1283 std::stringstream ss;
1284 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
1285 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1286 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1287 ss.str().c_str());
1288 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001289
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001290 if (regions[i].dstSubresource.layerCount == 0) {
1291 std::stringstream ss;
1292 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
1293 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1294 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s",
1295 ss.str().c_str());
1296 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001297
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001298 if (!GetDeviceExtensions(device_data)->khr_maintenance1_enabled) {
1299 // For each region the layerCount member of srcSubresource and dstSubresource must match
1300 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
1301 std::stringstream ss;
1302 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
1303 << "] do not match";
1304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1305 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
1306 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
1307 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001308 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001309
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001310 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
1311 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
1312 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
1313 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1314 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
1315 validation_error_map[VALIDATION_ERROR_01197]);
1316 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001317
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06001318 // For each region, the aspectMask member of srcSubresource must be present in the source image
1319 if (!VerifyAspectsPresent(regions[i].srcSubresource.aspectMask, src_image_state->createInfo.format)) {
1320 std::stringstream ss;
1321 ss << "vkCmdCopyImage: pRegion[" << i
1322 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
1323 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1324 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01200, "IMAGE", "%s. %s",
1325 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01200]);
1326 }
1327
1328 // For each region, the aspectMask member of dstSubresource must be present in the destination image
1329 if (!VerifyAspectsPresent(regions[i].dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
1330 std::stringstream ss;
1331 ss << "vkCmdCopyImage: pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
1332 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1333 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01201, "IMAGE", "%s. %s",
1334 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01201]);
1335 }
1336
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001337 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
1338 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
1339 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
1340 std::stringstream ss;
1341 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
1342 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1343 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
1344 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
1345 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001346
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001347 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
1348 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
1349 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
1350 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
1351 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
1352 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1353 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
1354 validation_error_map[VALIDATION_ERROR_01221]);
1355 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001356
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001357 if (!GetDeviceExtensions(device_data)->khr_maintenance1_enabled) {
1358 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
1359 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
1360 if (((src_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) ||
1361 (dst_image_state->createInfo.imageType == VK_IMAGE_TYPE_3D)) &&
1362 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
1363 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
1364 std::stringstream ss;
1365 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
1366 << "] baseArrayLayer was not zero or layerCount was not 1.";
1367 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1368 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
1369 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
1370 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001371 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001372
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001373 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
1374 if (regions[i].srcSubresource.mipLevel >= src_image_state->createInfo.mipLevels) {
1375 std::stringstream ss;
1376 ss << "vkCmdCopyImage: pRegions[" << i
1377 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
1378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1379 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1380 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1381 }
1382 if (regions[i].dstSubresource.mipLevel >= dst_image_state->createInfo.mipLevels) {
1383 std::stringstream ss;
1384 ss << "vkCmdCopyImage: pRegions[" << i
1385 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
1386 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1387 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
1388 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
1389 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001390
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001391 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
1392 // image was created
1393 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) >
1394 src_image_state->createInfo.arrayLayers) {
1395 std::stringstream ss;
1396 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_state->createInfo.arrayLayers << " but subRegion[" << i
1397 << "] baseArrayLayer + layerCount is "
1398 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
1399 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1400 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1401 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1402 }
1403 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) >
1404 dst_image_state->createInfo.arrayLayers) {
1405 std::stringstream ss;
1406 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_state->createInfo.arrayLayers << " but subRegion[" << i
1407 << "] baseArrayLayer + layerCount is "
1408 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
1409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1410 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
1411 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
1412 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001413
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001414 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
1415 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
1416 // The source region specified by a given element of regions must be a region that is contained within srcImage
1417 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, &(src_image_state->createInfo.extent))) {
1418 std::stringstream ss;
1419 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
1420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1421 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
1422 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
1423 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001424
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06001425 // The destination region specified by a given element of regions must be a region that is contained within dst_image
1426 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, &(dst_image_state->createInfo.extent))) {
1427 std::stringstream ss;
1428 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
1429 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1430 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
1431 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
1432 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001433 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001434
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001435 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
1436 // must not overlap in memory
1437 if (src_image_state->image == dst_image_state->image) {
1438 for (uint32_t j = 0; j < region_count; j++) {
1439 if (RegionIntersects(&regions[i], &regions[j], src_image_state->createInfo.imageType)) {
1440 std::stringstream ss;
1441 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
1442 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1443 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
1444 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001445 }
1446 }
1447 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001448 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001449
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001450 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
1451 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
1452 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
1453 if (vk_format_is_depth_or_stencil(src_image_state->createInfo.format) ||
1454 vk_format_is_depth_or_stencil(dst_image_state->createInfo.format)) {
1455 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1456 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
1457 skip |=
1458 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1459 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
1460 }
1461 } else {
1462 size_t srcSize = vk_format_get_size(src_image_state->createInfo.format);
1463 size_t destSize = vk_format_get_size(dst_image_state->createInfo.format);
1464 if (srcSize != destSize) {
1465 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
1466 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1467 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
1468 validation_error_map[VALIDATION_ERROR_01184]);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001469 }
1470 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001471
Dave Houlton33c22b72017-02-28 13:16:02 -07001472 // Source and dest image sample counts must match
1473 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
1474 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
1475 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 -06001476 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01185, "IMAGE", "%s %s", str,
1477 validation_error_map[VALIDATION_ERROR_01185]);
Dave Houlton33c22b72017-02-28 13:16:02 -07001478 }
1479
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001480 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02533);
1481 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", VALIDATION_ERROR_02534);
1482 // Validate that SRC & DST images have correct usage flags set
1483 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01178,
1484 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
1485 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01181,
1486 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001487 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
1488 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_01193);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001489 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
1490 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImage()", VALIDATION_ERROR_01194);
1491 for (uint32_t i = 0; i < region_count; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001492 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout,
1493 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_01180);
1494 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout,
1495 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", VALIDATION_ERROR_01183);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001496 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &regions[i], i,
1497 "vkCmdCopyImage()");
1498 }
1499
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001500 return skip;
1501}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001502
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001503void PreCallRecordCmdCopyImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001504 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkImageCopy *regions,
1505 VkImageLayout src_image_layout, VkImageLayout dst_image_layout) {
1506 // Make sure that all image slices are updated to correct layout
1507 for (uint32_t i = 0; i < region_count; ++i) {
1508 SetImageLayout(device_data, cb_node, src_image_state, regions[i].srcSubresource, src_image_layout);
1509 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].dstSubresource, dst_image_layout);
1510 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001511 // Update bindings between images and cmd buffer
1512 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1513 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Dave Houltoneba86e22017-03-02 14:56:23 -07001514 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImage()"); };
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001515 cb_node->validate_functions.push_back(function);
1516 function = [=]() {
1517 SetImageMemoryValid(device_data, dst_image_state, true);
1518 return false;
1519 };
1520 cb_node->validate_functions.push_back(function);
1521 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGE);
1522}
1523
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001524// TODO : Should be tracking lastBound per commandBuffer and when draws occur, report based on that cmd buffer lastBound
1525// Then need to synchronize the accesses based on cmd buffer so that if I'm reading state on one cmd buffer, updates
1526// to that same cmd buffer by separate thread are not changing state from underneath us
1527// Track the last cmd buffer touched by this thread
1528static bool hasDrawCmd(GLOBAL_CB_NODE *pCB) {
1529 for (uint32_t i = 0; i < NUM_DRAW_TYPES; i++) {
1530 if (pCB->drawCount[i]) return true;
1531 }
1532 return false;
1533}
1534
1535// Returns true if sub_rect is entirely contained within rect
1536static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
1537 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
1538 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
1539 return false;
1540 return true;
1541}
1542
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001543bool PreCallValidateCmdClearAttachments(layer_data *device_data, VkCommandBuffer commandBuffer, uint32_t attachmentCount,
1544 const VkClearAttachment *pAttachments, uint32_t rectCount, const VkClearRect *pRects) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001545 GLOBAL_CB_NODE *cb_node = GetCBNode(device_data, commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001546 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1547
1548 bool skip = false;
1549 if (cb_node) {
Mike Schuchardt9c582402017-02-23 15:57:37 -07001550 skip |=
1551 ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_01121);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001552 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001553 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001554 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
1555 if (!hasDrawCmd(cb_node) && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
1556 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
1557 // 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 -07001558 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
1559 // CmdClearAttachments.
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001560 skip |=
1561 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1562 reinterpret_cast<uint64_t &>(commandBuffer), 0, DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, "DS",
1563 "vkCmdClearAttachments() issued on command buffer object 0x%p prior to any Draw Cmds."
1564 " It is recommended you use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
1565 commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001566 }
1567 skip |= outsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", VALIDATION_ERROR_01122);
1568 }
1569
1570 // Validate that attachment is in reference list of active subpass
1571 if (cb_node->activeRenderPass) {
1572 const VkRenderPassCreateInfo *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
1573 const VkSubpassDescription *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001574 auto framebuffer = GetFramebufferState(device_data, cb_node->activeFramebuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001575
1576 for (uint32_t i = 0; i < attachmentCount; i++) {
1577 auto clear_desc = &pAttachments[i];
1578 VkImageView image_view = VK_NULL_HANDLE;
1579
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001580 if (0 == clear_desc->aspectMask) {
1581 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 -06001582 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01128, "IMAGE", "%s",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001583 validation_error_map[VALIDATION_ERROR_01128]);
1584 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
1585 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 -06001586 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01126, "IMAGE", "%s",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001587 validation_error_map[VALIDATION_ERROR_01126]);
1588 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001589 if (clear_desc->colorAttachment >= subpass_desc->colorAttachmentCount) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001590 skip |=
1591 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 -06001592 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01114, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001593 "vkCmdClearAttachments() color attachment index %d out of range for active subpass %d. %s",
1594 clear_desc->colorAttachment, cb_node->activeSubpass, validation_error_map[VALIDATION_ERROR_01114]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001595 } else if (subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment == VK_ATTACHMENT_UNUSED) {
1596 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001597 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer),
1598 __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001599 "vkCmdClearAttachments() color attachment index %d is VK_ATTACHMENT_UNUSED; ignored.",
1600 clear_desc->colorAttachment);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001601 } else {
1602 image_view = framebuffer->createInfo
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001603 .pAttachments[subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment];
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001604 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001605 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
1606 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1607 char const str[] =
1608 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
1609 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 -06001610 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01125, "IMAGE", str, i,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001611 validation_error_map[VALIDATION_ERROR_01125]);
1612 }
1613 } else { // Must be depth and/or stencil
1614 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1615 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1616 char const str[] = "vkCmdClearAttachments aspectMask [%d] is not a valid combination of bits. %s";
1617 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 -06001618 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01127, "IMAGE", str, i,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001619 validation_error_map[VALIDATION_ERROR_01127]);
1620 }
1621 if (!subpass_desc->pDepthStencilAttachment ||
1622 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
1623 skip |= log_msg(
1624 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001625 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001626 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001627 } else {
1628 image_view = framebuffer->createInfo.pAttachments[subpass_desc->pDepthStencilAttachment->attachment];
1629 }
1630 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001631 if (image_view) {
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001632 auto image_view_state = GetImageViewState(device_data, image_view);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001633 for (uint32_t j = 0; j < rectCount; j++) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001634 // The rectangular region specified by a given element of pRects must be contained within the render area of
1635 // the current render pass instance
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07001636 // TODO: This check should be moved to CmdExecuteCommands or QueueSubmit to cover secondary CB cases
1637 if ((cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) &&
1638 (false == ContainsRect(cb_node->activeRenderPassBeginInfo.renderArea, pRects[j].rect))) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001639 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1640 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01115, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001641 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
1642 "the current render pass instance. %s",
1643 j, validation_error_map[VALIDATION_ERROR_01115]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001644 }
1645 // The layers specified by a given element of pRects must be contained within every attachment that
1646 // pAttachments refers to
1647 auto attachment_base_array_layer = image_view_state->create_info.subresourceRange.baseArrayLayer;
1648 auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
1649 if ((pRects[j].baseArrayLayer < attachment_base_array_layer) || pRects[j].layerCount > attachment_layer_count) {
1650 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001651 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1652 reinterpret_cast<uint64_t>(commandBuffer), __LINE__, VALIDATION_ERROR_01116, "DS",
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07001653 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers of "
1654 "pAttachment[%d]. %s",
1655 j, i, validation_error_map[VALIDATION_ERROR_01116]);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07001656 }
1657 }
1658 }
1659 }
1660 }
1661 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001662}
1663
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001664bool PreCallValidateCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001665 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageResolve *pRegions) {
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001666 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001667 bool skip = false;
1668 if (cb_node && src_image_state && dst_image_state) {
1669 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02541);
1670 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()", VALIDATION_ERROR_02542);
Mike Schuchardt9c582402017-02-23 15:57:37 -07001671 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_01334);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001672 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
1673 skip |= insideRenderPass(device_data, cb_node, "vkCmdResolveImage()", VALIDATION_ERROR_01335);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001674
1675 // For each region, the number of layers in the image subresource should not be zero
1676 // For each region, src and dest image aspect must be color only
1677 for (uint32_t i = 0; i < regionCount; i++) {
1678 if (pRegions[i].srcSubresource.layerCount == 0) {
1679 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001680 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 -07001681 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1682 "IMAGE", str);
1683 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001684 if (pRegions[i].dstSubresource.layerCount == 0) {
1685 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001686 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 -07001687 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1688 "IMAGE", str);
1689 }
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001690 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1691 skip |= log_msg(
1692 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1693 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01339, "IMAGE",
1694 "vkCmdResolveImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s", i,
1695 validation_error_map[VALIDATION_ERROR_01339]);
1696 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07001697 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
1698 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
1699 char const str[] =
1700 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
1701 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1702 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01338, "IMAGE",
1703 "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
1704 }
1705 }
1706
1707 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
1708 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001709 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 -07001710 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_FORMAT,
1711 "IMAGE", str);
1712 }
1713 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
1714 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07001715 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 -07001716 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_TYPE, "IMAGE",
1717 str);
1718 }
1719 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
1720 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
1721 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1722 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01320, "IMAGE", "%s. %s",
1723 str, validation_error_map[VALIDATION_ERROR_01320]);
1724 }
1725 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
1726 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
1727 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1728 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01321, "IMAGE", "%s. %s",
1729 str, validation_error_map[VALIDATION_ERROR_01321]);
1730 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001731 } else {
1732 assert(0);
1733 }
1734 return skip;
1735}
1736
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001737void PreCallRecordCmdResolveImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1738 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001739 // Update bindings between images and cmd buffer
1740 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1741 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1742
1743 std::function<bool()> function = [=]() {
1744 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdResolveImage()");
1745 };
1746 cb_node->validate_functions.push_back(function);
1747 function = [=]() {
1748 SetImageMemoryValid(device_data, dst_image_state, true);
1749 return false;
1750 };
1751 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001752 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_RESOLVEIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001753}
1754
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001755bool PreCallValidateCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001756 IMAGE_STATE *dst_image_state, uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
1757 const debug_report_data *report_data = core_validation::GetReportData(device_data);
1758
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001759 bool skip = false;
1760 if (cb_node && src_image_state && dst_image_state) {
1761 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001762 VALIDATION_ERROR_02194);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001763 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001764 VALIDATION_ERROR_02195);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001765 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02539);
1766 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", VALIDATION_ERROR_02540);
1767 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_02182,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001768 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001769 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_02186,
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001770 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001771 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, VALIDATION_ERROR_01299);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001772 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
1773 skip |= insideRenderPass(device_data, cb_node, "vkCmdBlitImage()", VALIDATION_ERROR_01300);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001774
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001775 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001776 // Warn for zero-sized regions
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001777 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
1778 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
1779 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
1780 std::stringstream ss;
1781 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
1782 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1783 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1784 "%s", ss.str().c_str());
1785 }
1786 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
1787 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
1788 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
1789 std::stringstream ss;
1790 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
1791 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1792 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_INVALID_EXTENTS, "IMAGE",
1793 "%s", ss.str().c_str());
1794 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001795 if (pRegions[i].srcSubresource.layerCount == 0) {
1796 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1797 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 -07001798 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1799 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001800 }
1801 if (pRegions[i].dstSubresource.layerCount == 0) {
1802 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1803 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 -07001804 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, DRAWSTATE_MISMATCHED_IMAGE_ASPECT,
1805 "IMAGE", str);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07001806 }
1807
1808 // Check that src/dst layercounts match
1809 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
1810 skip |=
1811 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1812 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01304, "IMAGE",
1813 "vkCmdBlitImage: layerCount in source and destination subresource of pRegions[%d] does not match. %s",
1814 i, validation_error_map[VALIDATION_ERROR_01304]);
1815 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07001816
1817 if (pRegions[i].srcSubresource.aspectMask != pRegions[i].dstSubresource.aspectMask) {
1818 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1819 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_01303, "IMAGE",
1820 "vkCmdBlitImage: aspectMask members for pRegion[%d] do not match. %s", i,
1821 validation_error_map[VALIDATION_ERROR_01303]);
1822 }
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001823 }
1824
1825 VkFormat src_format = src_image_state->createInfo.format;
1826 VkFormat dst_format = dst_image_state->createInfo.format;
1827
1828 // Validate consistency for unsigned formats
1829 if (vk_format_is_uint(src_format) != vk_format_is_uint(dst_format)) {
1830 std::stringstream ss;
1831 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
1832 << "the other one must also have unsigned integer format. "
1833 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1834 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1835 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s",
1836 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02191]);
1837 }
1838
1839 // Validate consistency for signed formats
1840 if (vk_format_is_sint(src_format) != vk_format_is_sint(dst_format)) {
1841 std::stringstream ss;
1842 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
1843 << "the other one must also have signed integer format. "
1844 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
1845 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1846 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s",
1847 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02190]);
1848 }
1849
1850 // Validate aspect bits and formats for depth/stencil images
1851 if (vk_format_is_depth_or_stencil(src_format) || vk_format_is_depth_or_stencil(dst_format)) {
1852 if (src_format != dst_format) {
1853 std::stringstream ss;
1854 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1855 << "stencil, the other one must have exactly the same format. "
1856 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
1857 << string_VkFormat(dst_format);
1858 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1859 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02192, "IMAGE",
1860 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02192]);
1861 }
1862
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001863 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001864 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001865
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07001866 if (vk_format_is_depth_and_stencil(src_format)) {
1867 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
1868 std::stringstream ss;
1869 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1870 "VK_IMAGE_ASPECT_DEPTH_BIT "
1871 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
1872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1873 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1874 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1875 }
1876 } else if (vk_format_is_stencil_only(src_format)) {
1877 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1878 std::stringstream ss;
1879 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
1880 << "set in both the srcImage and dstImage";
1881 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1882 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1883 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1884 }
1885 } else if (vk_format_is_depth_only(src_format)) {
1886 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1887 std::stringstream ss;
1888 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
1889 << "set in both the srcImage and dstImage";
1890 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1891 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__,
1892 DRAWSTATE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
1893 }
1894 }
1895 }
1896 }
1897
1898 // Validate filter
1899 if (vk_format_is_depth_or_stencil(src_format) && (filter != VK_FILTER_NEAREST)) {
1900 std::stringstream ss;
1901 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1902 << "then filter must be VK_FILTER_NEAREST.";
1903 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1904 reinterpret_cast<uint64_t>(cb_node->commandBuffer), __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s",
1905 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02193]);
1906 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001907 } else {
1908 assert(0);
1909 }
1910 return skip;
1911}
1912
Tobin Ehlis58c884f2017-02-08 12:15:27 -07001913void PreCallRecordCmdBlitImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
1914 IMAGE_STATE *dst_image_state) {
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001915 // Update bindings between images and cmd buffer
1916 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
1917 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
1918
1919 std::function<bool()> function = [=]() { return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdBlitImage()"); };
1920 cb_node->validate_functions.push_back(function);
1921 function = [=]() {
1922 SetImageMemoryValid(device_data, dst_image_state, true);
1923 return false;
1924 };
1925 cb_node->validate_functions.push_back(function);
Tobin Ehlisb2e1e2c2017-02-08 09:16:32 -07001926 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_BLITIMAGE);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07001927}
1928
Tony Barbourdf013b92017-01-25 12:53:48 -07001929// This validates that the initial layout specified in the command buffer for
1930// the IMAGE is the same
1931// as the global IMAGE layout
Tony Barboure0c5cc92017-02-08 13:53:39 -07001932bool ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1933 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001934 bool skip = false;
Tony Barbourdf013b92017-01-25 12:53:48 -07001935 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001936 for (auto cb_image_data : pCB->imageLayoutMap) {
1937 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07001938
Jeremy Hayes55b6c292017-02-28 09:44:45 -07001939 if (FindLayout(imageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001940 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
1941 // TODO: Set memory invalid which is in mem_tracker currently
1942 } else if (imageLayout != cb_image_data.second.initialLayout) {
1943 if (cb_image_data.first.hasSubresource) {
Dave Houltoneba86e22017-03-02 14:56:23 -07001944 skip |= log_msg(
1945 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1946 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1947 "Cannot submit cmd buffer using image (0x%" PRIx64
1948 ") [sub-resource: aspectMask 0x%X array layer %u, mip level %u], "
1949 "with layout %s when first use is %s.",
1950 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), cb_image_data.first.subresource.aspectMask,
1951 cb_image_data.first.subresource.arrayLayer, cb_image_data.first.subresource.mipLevel,
1952 string_VkImageLayout(imageLayout), string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001953 } else {
Dave Houltoneba86e22017-03-02 14:56:23 -07001954 skip |=
1955 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1956 reinterpret_cast<uint64_t &>(pCB->commandBuffer), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
1957 "Cannot submit cmd buffer using image (0x%" PRIx64
1958 ") with layout %s when "
1959 "first use is %s.",
1960 reinterpret_cast<const uint64_t &>(cb_image_data.first.image), string_VkImageLayout(imageLayout),
1961 string_VkImageLayout(cb_image_data.second.initialLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001962 }
1963 }
Tony Barbourdf013b92017-01-25 12:53:48 -07001964 SetLayout(imageLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001965 }
1966 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07001967 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07001968}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001969
Tony Barbourdf013b92017-01-25 12:53:48 -07001970void UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
1971 for (auto cb_image_data : pCB->imageLayoutMap) {
1972 VkImageLayout imageLayout;
1973 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
1974 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
1975 }
1976}
1977
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07001978// Print readable FlagBits in FlagMask
1979static std::string string_VkAccessFlags(VkAccessFlags accessMask) {
1980 std::string result;
1981 std::string separator;
1982
1983 if (accessMask == 0) {
1984 result = "[None]";
1985 } else {
1986 result = "[";
1987 for (auto i = 0; i < 32; i++) {
1988 if (accessMask & (1 << i)) {
1989 result = result + separator + string_VkAccessFlagBits((VkAccessFlagBits)(1 << i));
1990 separator = " | ";
1991 }
1992 }
1993 result = result + "]";
1994 }
1995 return result;
1996}
1997
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07001998// AccessFlags MUST have 'required_bit' set, and may have one or more of 'optional_bits' set. If required_bit is zero, accessMask
1999// must have at least one of 'optional_bits' set
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002000// TODO: Add tracking to ensure that at least one barrier has been set for these layout transitions
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002001static bool ValidateMaskBits(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer, const VkAccessFlags &accessMask,
2002 const VkImageLayout &layout, VkAccessFlags required_bit, VkAccessFlags optional_bits,
2003 const char *type) {
2004 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2005 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002006
2007 if ((accessMask & required_bit) || (!required_bit && (accessMask & optional_bits))) {
2008 if (accessMask & ~(required_bit | optional_bits)) {
2009 // TODO: Verify against Valid Use
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002010 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2011 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002012 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2013 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002014 }
2015 } else {
2016 if (!required_bit) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002017 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2018 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002019 "%s AccessMask %d %s must contain at least one of access bits %d "
2020 "%s when layout is %s, unless the app has previously added a "
2021 "barrier for this transition.",
2022 type, accessMask, string_VkAccessFlags(accessMask).c_str(), optional_bits,
2023 string_VkAccessFlags(optional_bits).c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002024 } else {
2025 std::string opt_bits;
2026 if (optional_bits != 0) {
2027 std::stringstream ss;
2028 ss << optional_bits;
2029 opt_bits = "and may have optional bits " + ss.str() + ' ' + string_VkAccessFlags(optional_bits);
2030 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002031 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2032 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002033 "%s AccessMask %d %s must have required access bit %d %s %s when "
2034 "layout is %s, unless the app has previously added a barrier for "
2035 "this transition.",
2036 type, accessMask, string_VkAccessFlags(accessMask).c_str(), required_bit,
2037 string_VkAccessFlags(required_bit).c_str(), opt_bits.c_str(), string_VkImageLayout(layout));
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002038 }
2039 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002040 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002041}
2042
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002043bool ValidateMaskBitsFromLayouts(core_validation::layer_data *device_data, VkCommandBuffer cmdBuffer,
2044 const VkAccessFlags &accessMask, const VkImageLayout &layout, const char *type) {
2045 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002046
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002047 bool skip = false;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002048 switch (layout) {
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002049 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL: {
2050 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
2051 VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2052 break;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002053 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002054 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL: {
2055 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
2056 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, type);
2057 break;
2058 }
2059 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL: {
2060 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_WRITE_BIT, 0, type);
2061 break;
2062 }
2063 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL: {
2064 skip |= ValidateMaskBits(
2065 device_data, cmdBuffer, accessMask, layout, 0,
2066 VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT,
2067 type);
2068 break;
2069 }
2070 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL: {
2071 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, 0,
2072 VK_ACCESS_INPUT_ATTACHMENT_READ_BIT | VK_ACCESS_SHADER_READ_BIT, type);
2073 break;
2074 }
2075 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL: {
2076 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_TRANSFER_READ_BIT, 0, type);
2077 break;
2078 }
2079 case VK_IMAGE_LAYOUT_PRESENT_SRC_KHR: {
2080 skip |= ValidateMaskBits(device_data, cmdBuffer, accessMask, layout, VK_ACCESS_MEMORY_READ_BIT, 0, type);
2081 break;
2082 }
2083 case VK_IMAGE_LAYOUT_UNDEFINED: {
2084 if (accessMask != 0) {
2085 // TODO: Verify against Valid Use section spec
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002086 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2087 reinterpret_cast<uint64_t>(cmdBuffer), __LINE__, DRAWSTATE_INVALID_BARRIER, "DS",
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002088 "Additional bits in %s accessMask 0x%X %s are specified when layout is %s.", type, accessMask,
2089 string_VkAccessFlags(accessMask).c_str(), string_VkImageLayout(layout));
2090 }
2091 break;
2092 }
2093 case VK_IMAGE_LAYOUT_GENERAL:
2094 default: { break; }
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002095 }
Mark Lobodzinski9a8d40f2017-02-07 17:00:12 -07002096 return skip;
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07002097}
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002098
2099// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002100// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
2101// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002102bool ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, const VkImageLayout first_layout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002103 const uint32_t attachment, const VkAttachmentDescription &attachment_description) {
2104 bool skip = false;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002105 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
2106 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2107 if ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
2108 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002109 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
2110 VkDebugReportObjectTypeEXT(0), __LINE__, VALIDATION_ERROR_02351, "DS",
2111 "Cannot clear attachment %d with invalid first layout %s. %s", attachment,
2112 string_VkImageLayout(first_layout), validation_error_map[VALIDATION_ERROR_02351]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002113 }
2114 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002115 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002116}
2117
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002118bool ValidateLayouts(core_validation::layer_data *device_data, VkDevice device, const VkRenderPassCreateInfo *pCreateInfo) {
2119 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002120 bool skip = false;
2121
2122 // Track when we're observing the first use of an attachment
2123 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
2124 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
2125 const VkSubpassDescription &subpass = pCreateInfo->pSubpasses[i];
2126 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
2127 auto attach_index = subpass.pColorAttachments[j].attachment;
2128 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2129
2130 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002131 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
2132 // This is ideal.
2133 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002134
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002135 case VK_IMAGE_LAYOUT_GENERAL:
2136 // May not be optimal; TODO: reconsider this warning based on other constraints?
2137 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2138 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2139 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
2140 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002141
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002142 default:
2143 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2144 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2145 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
2146 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002147 }
2148
2149 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002150 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pColorAttachments[j].layout, attach_index,
2151 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002152 }
2153 attach_first_use[attach_index] = false;
2154 }
2155 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
2156 switch (subpass.pDepthStencilAttachment->layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002157 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
2158 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2159 // These are ideal.
2160 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002161
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002162 case VK_IMAGE_LAYOUT_GENERAL:
2163 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
2164 // doing a bunch of transitions.
2165 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2166 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2167 "GENERAL layout for depth attachment may not give optimal performance.");
2168 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002169
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002170 default:
2171 // No other layouts are acceptable
2172 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2173 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2174 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
2175 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
2176 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002177 }
2178
2179 auto attach_index = subpass.pDepthStencilAttachment->attachment;
2180 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002181 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pDepthStencilAttachment->layout, attach_index,
2182 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002183 }
2184 attach_first_use[attach_index] = false;
2185 }
2186 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
2187 auto attach_index = subpass.pInputAttachments[j].attachment;
2188 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
2189
2190 switch (subpass.pInputAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002191 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
2192 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
2193 // These are ideal.
2194 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002195
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002196 case VK_IMAGE_LAYOUT_GENERAL:
2197 // May not be optimal. TODO: reconsider this warning based on other constraints.
2198 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
2199 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2200 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
2201 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002202
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002203 default:
2204 // No other layouts are acceptable
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002205 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
2206 __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002207 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
2208 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002209 }
2210
2211 if (attach_first_use[attach_index]) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07002212 skip |= ValidateLayoutVsAttachmentDescription(report_data, subpass.pInputAttachments[j].layout, attach_index,
2213 pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07002214 }
2215 attach_first_use[attach_index] = false;
2216 }
2217 }
2218 return skip;
2219}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002220
2221// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002222bool ValidateMapImageLayouts(core_validation::layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
2223 VkDeviceSize offset, VkDeviceSize end_offset) {
2224 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2225 bool skip = false;
2226 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
2227 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002228 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
2229 for (auto image_handle : mem_info->bound_images) {
2230 auto img_it = mem_info->bound_ranges.find(image_handle);
2231 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002232 if (rangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002233 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002234 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002235 for (auto layout : layouts) {
2236 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002237 skip |= log_msg(
2238 report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
2239 reinterpret_cast<const uint64_t &>(mem_info->mem), __LINE__, DRAWSTATE_INVALID_IMAGE_LAYOUT, "DS",
2240 "Mapping an image with layout %s can result in undefined behavior if this memory is "
2241 "used by the device. Only GENERAL or PREINITIALIZED should be used.",
2242 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002243 }
2244 }
2245 }
2246 }
2247 }
2248 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07002249 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07002250}
Mark Lobodzinski96210742017-02-09 10:33:46 -07002251
2252// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
2253// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002254static 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 -07002255 VkDebugReportObjectTypeEXT obj_type, int32_t const msgCode, char const *ty_str,
2256 char const *func_name, char const *usage_str) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002257 const debug_report_data *report_data = core_validation::GetReportData(device_data);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002258
2259 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002260 bool skip = false;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002261 if (strict) {
2262 correct_usage = ((actual & desired) == desired);
2263 } else {
2264 correct_usage = ((actual & desired) != 0);
2265 }
2266 if (!correct_usage) {
2267 if (msgCode == -1) {
2268 // TODO: Fix callers with msgCode == -1 to use correct validation checks.
Dave Houltoneba86e22017-03-02 14:56:23 -07002269 skip = log_msg(
2270 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, MEMTRACK_INVALID_USAGE_FLAG, "MEM",
2271 "Invalid usage flag for %s 0x%" PRIxLEAST64 " used by %s. In this case, %s should have %s set during creation.",
2272 ty_str, obj_handle, func_name, ty_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002273 } else {
2274 const char *valid_usage = (msgCode == -1) ? "" : validation_error_map[msgCode];
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002275 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, obj_type, obj_handle, __LINE__, msgCode, "MEM",
2276 "Invalid usage flag for %s 0x%" PRIxLEAST64
2277 " used by %s. In this case, %s should have %s set during creation. %s",
2278 ty_str, obj_handle, func_name, ty_str, usage_str, valid_usage);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002279 }
2280 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002281 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002282}
2283
2284// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2285// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002286bool ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002287 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002288 return validate_usage_flags(device_data, image_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002289 reinterpret_cast<const uint64_t &>(image_state->image), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2290 msgCode, "image", func_name, usage_string);
2291}
2292
2293// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
2294// where an error will be flagged if usage is not correct
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002295bool ValidateBufferUsageFlags(layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired, VkBool32 strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002296 int32_t const msgCode, char const *func_name, char const *usage_string) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002297 return validate_usage_flags(device_data, buffer_state->createInfo.usage, desired, strict,
Mark Lobodzinski96210742017-02-09 10:33:46 -07002298 reinterpret_cast<const uint64_t &>(buffer_state->buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
2299 msgCode, "buffer", func_name, usage_string);
2300}
2301
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002302bool PreCallValidateCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07002303 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002304 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2305
Mark Lobodzinski96210742017-02-09 10:33:46 -07002306 // TODO: Add check for VALIDATION_ERROR_00658
Mark Lobodzinski96210742017-02-09 10:33:46 -07002307 // TODO: Add check for VALIDATION_ERROR_00667
2308 // TODO: Add check for VALIDATION_ERROR_00668
2309 // TODO: Add check for VALIDATION_ERROR_00669
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06002310
2311 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures(device_data)->sparseBinding)) {
2312 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2313 VALIDATION_ERROR_00666, "DS",
2314 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
2315 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set. %s",
2316 validation_error_map[VALIDATION_ERROR_00666]);
2317 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06002318
2319 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyBuffer)) {
2320 skip |=
2321 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2322 DRAWSTATE_INVALID_FEATURE, "DS",
2323 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with the "
2324 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
2325 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06002326
2327 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures(device_data)->sparseResidencyAliased)) {
2328 skip |=
2329 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2330 DRAWSTATE_INVALID_FEATURE, "DS",
2331 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with the "
2332 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
2333 }
Mark Lobodzinski96210742017-02-09 10:33:46 -07002334 return skip;
2335}
2336
2337void PostCallRecordCreateBuffer(layer_data *device_data, const VkBufferCreateInfo *pCreateInfo, VkBuffer *pBuffer) {
2338 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
2339 GetBufferMap(device_data)
2340 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
2341}
2342
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002343bool PreCallValidateCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo) {
2344 bool skip = false;
2345 BUFFER_STATE *buffer_state = GetBufferState(device_data, pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002346 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
2347 if (buffer_state) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002348 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()", VALIDATION_ERROR_02522);
Mark Lobodzinski96210742017-02-09 10:33:46 -07002349 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
2350 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002351 skip |= ValidateBufferUsageFlags(
2352 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 -07002353 VALIDATION_ERROR_00694, "vkCreateBufferView()", "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
2354 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07002355 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07002356}
2357
2358void PostCallRecordCreateBufferView(layer_data *device_data, const VkBufferViewCreateInfo *pCreateInfo, VkBufferView *pView) {
2359 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
2360}
Mark Lobodzinski602de982017-02-09 11:01:33 -07002361
2362// For the given format verify that the aspect masks make sense
2363bool ValidateImageAspectMask(layer_data *device_data, VkImage image, VkFormat format, VkImageAspectFlags aspect_mask,
2364 const char *func_name) {
2365 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2366 bool skip = false;
2367 if (vk_format_is_color(format)) {
2368 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
2369 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2370 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2371 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2372 validation_error_map[VALIDATION_ERROR_00741]);
2373 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
2374 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2375 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2376 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set. %s", func_name,
2377 validation_error_map[VALIDATION_ERROR_00741]);
2378 }
2379 } else if (vk_format_is_depth_and_stencil(format)) {
2380 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
2381 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2382 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2383 "%s: Depth/stencil image formats must have "
2384 "at least one of VK_IMAGE_ASPECT_DEPTH_BIT "
2385 "and VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2386 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2387 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
2388 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2389 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2390 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
2391 "VK_IMAGE_ASPECT_STENCIL_BIT set. %s",
2392 func_name, validation_error_map[VALIDATION_ERROR_00741]);
2393 }
2394 } else if (vk_format_is_depth_only(format)) {
2395 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
2396 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2397 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2398 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2399 validation_error_map[VALIDATION_ERROR_00741]);
2400 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
2401 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2402 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2403 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set. %s", func_name,
2404 validation_error_map[VALIDATION_ERROR_00741]);
2405 }
2406 } else if (vk_format_is_stencil_only(format)) {
2407 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
2408 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2409 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2410 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2411 validation_error_map[VALIDATION_ERROR_00741]);
2412 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
2413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, (uint64_t)image,
2414 __LINE__, VALIDATION_ERROR_00741, "IMAGE",
2415 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set. %s", func_name,
2416 validation_error_map[VALIDATION_ERROR_00741]);
2417 }
2418 }
2419 return skip;
2420}
2421
2422bool ValidateImageSubrangeLevelLayerCounts(layer_data *device_data, const VkImageSubresourceRange &subresourceRange,
2423 const char *func_name) {
2424 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2425 bool skip = false;
2426 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002427 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 -07002428 VALIDATION_ERROR_00768, "IMAGE", "%s called with 0 in subresourceRange.levelCount. %s", func_name,
2429 validation_error_map[VALIDATION_ERROR_00768]);
2430 }
2431 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002432 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 -07002433 VALIDATION_ERROR_00769, "IMAGE", "%s called with 0 in subresourceRange.layerCount. %s", func_name,
2434 validation_error_map[VALIDATION_ERROR_00769]);
2435 }
2436 return skip;
2437}
2438
2439bool PreCallValidateCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
2440 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2441 bool skip = false;
2442 IMAGE_STATE *image_state = GetImageState(device_data, create_info->image);
2443 if (image_state) {
2444 skip |= ValidateImageUsageFlags(
2445 device_data, image_state,
2446 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
2447 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
2448 false, -1, "vkCreateImageView()",
2449 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT]_BIT");
2450 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
2451 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", VALIDATION_ERROR_02524);
2452 // Checks imported from image layer
2453 if (create_info->subresourceRange.baseMipLevel >= image_state->createInfo.mipLevels) {
2454 std::stringstream ss;
2455 ss << "vkCreateImageView called with baseMipLevel " << create_info->subresourceRange.baseMipLevel << " for image "
2456 << create_info->image << " that only has " << image_state->createInfo.mipLevels << " mip levels.";
2457 skip |=
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002458 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 -07002459 VALIDATION_ERROR_00768, "IMAGE", "%s %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_00768]);
2460 }
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002461 if (!GetDeviceExtensions(device_data)->khr_maintenance1_enabled) {
2462 if (create_info->subresourceRange.baseArrayLayer >= image_state->createInfo.arrayLayers) {
2463 std::stringstream ss;
2464 ss << "vkCreateImageView called with baseArrayLayer " << create_info->subresourceRange.baseArrayLayer
2465 << " for image " << create_info->image << " that only has " << image_state->createInfo.arrayLayers
2466 << " array layers.";
2467 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
2468 VALIDATION_ERROR_00769, "IMAGE", "%s %s", ss.str().c_str(),
2469 validation_error_map[VALIDATION_ERROR_00769]);
2470 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07002471 }
2472 // TODO: Need new valid usage language for levelCount == 0 & layerCount == 0
2473 skip |= ValidateImageSubrangeLevelLayerCounts(device_data, create_info->subresourceRange, "vkCreateImageView()");
2474
2475 VkImageCreateFlags image_flags = image_state->createInfo.flags;
2476 VkFormat image_format = image_state->createInfo.format;
2477 VkFormat view_format = create_info->format;
2478 VkImageAspectFlags aspect_mask = create_info->subresourceRange.aspectMask;
2479
2480 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state
2481 if (image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) {
2482 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
2483 if (vk_format_get_compatibility_class(image_format) != vk_format_get_compatibility_class(view_format)) {
2484 std::stringstream ss;
2485 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
2486 << " is not in the same format compatibility class as image (" << (uint64_t)create_info->image << ") format "
2487 << string_VkFormat(image_format) << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
2488 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002489 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 -07002490 VALIDATION_ERROR_02171, "IMAGE", "%s %s", ss.str().c_str(),
2491 validation_error_map[VALIDATION_ERROR_02171]);
2492 }
2493 } else {
2494 // Format MUST be IDENTICAL to the format the image was created with
2495 if (image_format != view_format) {
2496 std::stringstream ss;
2497 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
2498 << (uint64_t)create_info->image << " format " << string_VkFormat(image_format)
2499 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06002500 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 -07002501 VALIDATION_ERROR_02172, "IMAGE", "%s %s", ss.str().c_str(),
2502 validation_error_map[VALIDATION_ERROR_02172]);
2503 }
2504 }
2505
2506 // Validate correct image aspect bits for desired formats and format consistency
2507 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
2508 }
2509 return skip;
2510}
2511
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07002512void PostCallRecordCreateImageView(layer_data *device_data, const VkImageViewCreateInfo *create_info, VkImageView view) {
2513 auto image_view_map = GetImageViewMap(device_data);
2514 (*image_view_map)[view] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(view, create_info));
2515
2516 auto image_state = GetImageState(device_data, create_info->image);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002517 auto &sub_res_range = (*image_view_map)[view].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06002518 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
2519 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07002520}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002521
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002522bool PreCallValidateCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2523 BUFFER_STATE *dst_buffer_state) {
2524 bool skip = false;
2525 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02531);
2526 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", VALIDATION_ERROR_02532);
2527 // Validate that SRC & DST buffers have correct usage flags set
2528 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01164,
2529 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
2530 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01165,
2531 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07002532 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
2533 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_01171);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002534 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
2535 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", VALIDATION_ERROR_01172);
2536 return skip;
2537}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002538
Mark Lobodzinski680421d2017-02-09 13:06:56 -07002539void PreCallRecordCmdCopyBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
2540 BUFFER_STATE *dst_buffer_state) {
2541 // Update bindings between buffers and cmd buffer
2542 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
2543 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
2544
2545 std::function<bool()> function = [=]() {
2546 return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBuffer()");
2547 };
2548 cb_node->validate_functions.push_back(function);
2549 function = [=]() {
2550 SetBufferMemoryValid(device_data, dst_buffer_state, true);
2551 return false;
2552 };
2553 cb_node->validate_functions.push_back(function);
2554 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFER);
2555}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07002556
2557static bool validateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
2558 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2559 bool skip = false;
2560 auto buffer_state = GetBufferState(device_data, buffer);
2561 if (!buffer_state) {
2562 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2563 __LINE__, DRAWSTATE_DOUBLE_DESTROY, "DS",
2564 "Cannot free buffer 0x%" PRIxLEAST64 " that has not been allocated.", (uint64_t)(buffer));
2565 } else {
2566 if (buffer_state->in_use.load()) {
2567 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, (uint64_t)(buffer),
2568 __LINE__, VALIDATION_ERROR_00676, "DS",
2569 "Cannot free buffer 0x%" PRIxLEAST64 " that is in use by a command buffer. %s", (uint64_t)(buffer),
2570 validation_error_map[VALIDATION_ERROR_00676]);
2571 }
2572 }
2573 return skip;
2574}
2575
2576bool PreCallValidateDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE **image_view_state,
2577 VK_OBJECT *obj_struct) {
2578 *image_view_state = GetImageViewState(device_data, image_view);
2579 *obj_struct = {reinterpret_cast<uint64_t &>(image_view), VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_VIEW_EXT};
2580 if (GetDisables(device_data)->destroy_image_view) return false;
2581 bool skip = false;
2582 if (*image_view_state) {
2583 skip |= ValidateObjectNotInUse(device_data, *image_view_state, *obj_struct, VALIDATION_ERROR_00776);
2584 }
2585 return skip;
2586}
2587
2588void PostCallRecordDestroyImageView(layer_data *device_data, VkImageView image_view, IMAGE_VIEW_STATE *image_view_state,
2589 VK_OBJECT obj_struct) {
2590 // Any bound cmd buffers are now invalid
2591 invalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
2592 (*GetImageViewMap(device_data)).erase(image_view);
2593}
2594
2595bool PreCallValidateDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE **buffer_state, VK_OBJECT *obj_struct) {
2596 *buffer_state = GetBufferState(device_data, buffer);
2597 *obj_struct = {reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT};
2598 if (GetDisables(device_data)->destroy_buffer) return false;
2599 bool skip = false;
2600 if (*buffer_state) {
2601 skip |= validateIdleBuffer(device_data, buffer);
2602 }
2603 return skip;
2604}
2605
2606void PostCallRecordDestroyBuffer(layer_data *device_data, VkBuffer buffer, BUFFER_STATE *buffer_state, VK_OBJECT obj_struct) {
2607 invalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
2608 for (auto mem_binding : buffer_state->GetBoundMemory()) {
2609 auto mem_info = GetMemObjInfo(device_data, mem_binding);
2610 if (mem_info) {
2611 core_validation::RemoveBufferMemoryRange(reinterpret_cast<uint64_t &>(buffer), mem_info);
2612 }
2613 }
2614 ClearMemoryObjectBindings(device_data, reinterpret_cast<uint64_t &>(buffer), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT);
2615 GetBufferMap(device_data)->erase(buffer_state->buffer);
2616}
2617
2618bool PreCallValidateDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE **buffer_view_state,
2619 VK_OBJECT *obj_struct) {
2620 *buffer_view_state = GetBufferViewState(device_data, buffer_view);
2621 *obj_struct = {reinterpret_cast<uint64_t &>(buffer_view), VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_VIEW_EXT};
2622 if (GetDisables(device_data)->destroy_buffer_view) return false;
2623 bool skip = false;
2624 if (*buffer_view_state) {
2625 skip |= ValidateObjectNotInUse(device_data, *buffer_view_state, *obj_struct, VALIDATION_ERROR_00701);
2626 }
2627 return skip;
2628}
2629
2630void PostCallRecordDestroyBufferView(layer_data *device_data, VkBufferView buffer_view, BUFFER_VIEW_STATE *buffer_view_state,
2631 VK_OBJECT obj_struct) {
2632 // Any bound cmd buffers are now invalid
2633 invalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
2634 GetBufferViewMap(device_data)->erase(buffer_view);
2635}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002636
2637bool PreCallValidateCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2638 bool skip = false;
2639 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", VALIDATION_ERROR_02529);
Mike Schuchardt9c582402017-02-23 15:57:37 -07002640 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
2641 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, VALIDATION_ERROR_01141);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07002642 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
2643 // Validate that DST buffer has correct usage flags set
2644 skip |= ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01137,
2645 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
2646 skip |= insideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", VALIDATION_ERROR_01142);
2647 return skip;
2648}
2649
2650void PreCallRecordCmdFillBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *buffer_state) {
2651 std::function<bool()> function = [=]() {
2652 SetBufferMemoryValid(device_data, buffer_state, true);
2653 return false;
2654 };
2655 cb_node->validate_functions.push_back(function);
2656 // Update bindings between buffer and cmd buffer
2657 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
2658 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_FILLBUFFER);
2659}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002660
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002661bool ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
2662 IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002663 bool skip = false;
2664
2665 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002666 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
2667 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002668 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 -07002669 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01746, "IMAGE",
2670 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these "
2671 "must be 0 and 1, respectively. %s",
2672 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height,
2673 validation_error_map[VALIDATION_ERROR_01746]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002674 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002675 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002676
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002677 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
2678 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002679 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 -07002680 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01747, "IMAGE",
2681 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
2682 "must be 0 and 1, respectively. %s",
2683 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
2684 validation_error_map[VALIDATION_ERROR_01747]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002685 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002686 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002687
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002688 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2689 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
2690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2691 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01281, "IMAGE",
2692 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is "
2693 "%d. For 3D images these must be 0 and 1, respectively. %s",
2694 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount,
2695 validation_error_map[VALIDATION_ERROR_01281]);
2696 }
2697 }
2698
2699 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
2700 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
2701 auto texel_size = vk_format_get_size(image_state->createInfo.format);
2702 if (!vk_format_is_depth_and_stencil(image_state->createInfo.format) &&
2703 vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
2704 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2705 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
2706 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
2707 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
2708 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
2709 }
2710
2711 // BufferOffset must be a multiple of 4
2712 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
2713 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2714 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
2715 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
2716 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
2717 }
2718
2719 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
2720 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
2721 skip |= log_msg(
2722 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2723 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
2724 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
2725 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
2726 validation_error_map[VALIDATION_ERROR_01265]);
2727 }
2728
2729 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
2730 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
2731 skip |= log_msg(
2732 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2733 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
2734 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
2735 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
2736 validation_error_map[VALIDATION_ERROR_01266]);
2737 }
2738
2739 // subresource aspectMask must have exactly 1 bit set
2740 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
2741 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
2742 if (aspect_mask_bits.count() != 1) {
2743 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2744 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
2745 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
2746 validation_error_map[VALIDATION_ERROR_01280]);
2747 }
2748
2749 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002750 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002751 skip |= log_msg(
2752 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2753 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01279, "IMAGE",
2754 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x. %s",
2755 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format,
2756 validation_error_map[VALIDATION_ERROR_01279]);
2757 }
2758
2759 // Checks that apply only to compressed images
2760 // TODO: there is a comment in ValidateCopyBufferImageTransferGranularityRequirements() in core_validation.cpp that
2761 // reserves a place for these compressed image checks. This block of code could move there once the image
2762 // stuff is moved into core validation.
2763 if (vk_format_is_compressed(image_state->createInfo.format)) {
2764 auto block_size = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2765
2766 // BufferRowLength must be a multiple of block width
2767 if (vk_safe_modulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002768 skip |= log_msg(
2769 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002770 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01271, "IMAGE",
2771 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d). %s.",
2772 function, i, pRegions[i].bufferRowLength, block_size.width, validation_error_map[VALIDATION_ERROR_01271]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002773 }
2774
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002775 // BufferRowHeight must be a multiple of block height
2776 if (vk_safe_modulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002777 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 -07002778 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01272, "IMAGE",
2779 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel "
2780 "height (%d). %s.",
2781 function, i, pRegions[i].bufferImageHeight, block_size.height,
2782 validation_error_map[VALIDATION_ERROR_01272]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002783 }
2784
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002785 // image offsets must be multiples of block dimensions
2786 if ((vk_safe_modulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
Dave Houlton75967fc2017-03-06 17:21:16 -07002787 (vk_safe_modulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
2788 (vk_safe_modulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002789 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2790 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01273, "IMAGE",
2791 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
2792 "width & height (%d, %d). %s.",
2793 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
2794 block_size.height, validation_error_map[VALIDATION_ERROR_01273]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002795 }
2796
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002797 // bufferOffset must be a multiple of block size (linear bytes)
2798 size_t block_size_in_bytes = vk_format_get_size(image_state->createInfo.format);
2799 if (vk_safe_modulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
2800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2801 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01274, "IMAGE",
2802 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
2803 ") must be a multiple of the compressed image's texel block "
2804 "size (" PRINTF_SIZE_T_SPECIFIER "). %s.",
2805 function, i, pRegions[i].bufferOffset, block_size_in_bytes,
2806 validation_error_map[VALIDATION_ERROR_01274]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002807 }
Dave Houlton67e9b532017-03-02 17:00:10 -07002808
2809 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07002810 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton67e9b532017-03-02 17:00:10 -07002811 if ((vk_safe_modulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002812 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
2813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2814 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01275, "IMAGE",
2815 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
2816 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d). %s.",
2817 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
2818 mip_extent.width, validation_error_map[VALIDATION_ERROR_01275]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002819 }
2820
2821 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
2822 if ((vk_safe_modulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002823 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
2824 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2825 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01276, "IMAGE",
2826 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
2827 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d). %s.",
2828 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
2829 mip_extent.height, validation_error_map[VALIDATION_ERROR_01276]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002830 }
2831
2832 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
2833 if ((vk_safe_modulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07002834 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
2835 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
2836 reinterpret_cast<uint64_t &>(image_state->image), __LINE__, VALIDATION_ERROR_01277, "IMAGE",
2837 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
2838 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d). %s.",
2839 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
2840 mip_extent.depth, validation_error_map[VALIDATION_ERROR_01277]);
Dave Houlton67e9b532017-03-02 17:00:10 -07002841 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002842 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002843 }
2844
2845 return skip;
2846}
2847
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002848static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
2849 const VkBufferImageCopy *pRegions, const char *func_name, UNIQUE_VALIDATION_ERROR_CODE msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002850 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002851 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002852
2853 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002854 VkExtent3D extent = pRegions[i].imageExtent;
2855 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002856
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002857 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
2858 {
2859 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2860 (uint64_t)0, __LINE__, IMAGE_ZERO_AREA_SUBREGION, "IMAGE",
2861 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
2862 extent.height, extent.depth);
2863 }
2864
2865 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
2866
2867 // 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 -07002868 if (vk_format_is_compressed(image_info->format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002869 auto block_extent = vk_format_compressed_texel_block_extents(image_info->format);
2870 if (image_extent.width % block_extent.width) {
2871 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
2872 }
2873 if (image_extent.height % block_extent.height) {
2874 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
2875 }
2876 if (image_extent.depth % block_extent.depth) {
2877 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
2878 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002879 }
2880
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002881 if (ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002882 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 -07002883 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds image bounds. %s.", func_name, i,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002884 validation_error_map[msg_code]);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002885 }
2886 }
2887
2888 return skip;
2889}
2890
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002891static inline bool ValidtateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
2892 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
2893 UNIQUE_VALIDATION_ERROR_CODE msg_code) {
2894 bool skip = false;
2895
2896 VkDeviceSize buffer_size = buff_state->createInfo.size;
2897
2898 for (uint32_t i = 0; i < regionCount; i++) {
2899 VkExtent3D copy_extent = pRegions[i].imageExtent;
2900
2901 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
2902 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
2903 VkDeviceSize unit_size = vk_format_get_size(image_state->createInfo.format); // size (bytes) of texel or block
2904
Dave Houltonf3229d52017-02-21 15:59:08 -07002905 // Handle special buffer packing rules for specific depth/stencil formats
2906 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2907 unit_size = vk_format_get_size(VK_FORMAT_S8_UINT);
2908 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2909 switch (image_state->createInfo.format) {
2910 case VK_FORMAT_D16_UNORM_S8_UINT:
2911 unit_size = vk_format_get_size(VK_FORMAT_D16_UNORM);
2912 break;
2913 case VK_FORMAT_D32_SFLOAT_S8_UINT:
2914 unit_size = vk_format_get_size(VK_FORMAT_D32_SFLOAT);
2915 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002916 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07002917 case VK_FORMAT_D24_UNORM_S8_UINT:
2918 unit_size = 4;
2919 break;
2920 default:
2921 break;
2922 }
2923 }
2924
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002925 if (vk_format_is_compressed(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002926 // Switch to texel block units, rounding up for any partially-used blocks
2927 auto block_dim = vk_format_compressed_texel_block_extents(image_state->createInfo.format);
2928 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
2929 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
2930
2931 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
2932 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
2933 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002934 }
2935
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002936 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
2937 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
2938 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
2939 // TODO: Issure warning here? Already warned in ValidateImageBounds()...
2940 } else {
2941 // Calculate buffer offset of final copied byte, + 1.
2942 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
2943 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
2944 max_buffer_offset *= unit_size; // convert to bytes
2945 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002946
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002947 if (buffer_size < max_buffer_offset) {
2948 skip |=
2949 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
2950 __LINE__, msg_code, "IMAGE", "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes. %s.", func_name,
2951 i, buffer_size, validation_error_map[msg_code]);
2952 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002953 }
2954 }
2955
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002956 return skip;
2957}
2958
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002959bool PreCallValidateCmdCopyImageToBuffer(layer_data *device_data, VkImageLayout srcImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002960 IMAGE_STATE *src_image_state, BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07002961 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002962 const debug_report_data *report_data = core_validation::GetReportData(device_data);
2963 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
2964
2965 // Validate command buffer state
2966 if (CB_RECORDING != cb_node->state) {
2967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2968 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01258, "DS",
2969 "Cannot call vkCmdCopyImageToBuffer() on command buffer which is not in recording state. %s.",
2970 validation_error_map[VALIDATION_ERROR_01258]);
2971 } else {
2972 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYIMAGETOBUFFER);
2973 }
2974
2975 // Command pool must support graphics, compute, or transfer operations
2976 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
2977
2978 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
2979 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
2980 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2981 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01259, "DS",
2982 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
2983 "or transfer capabilities. %s.",
2984 validation_error_map[VALIDATION_ERROR_01259]);
2985 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002986 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002987 VALIDATION_ERROR_01245);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002988 skip |= ValidtateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002989 VALIDATION_ERROR_01246);
2990
2991 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
2992 VALIDATION_ERROR_01249);
2993 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02537);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002994 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_02538);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07002995
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07002996 // Validate that SRC image & DST buffer have correct usage flags set
2997 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01248,
2998 "vkCmdCopyImageToBuffer()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07002999 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01252,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003000 "vkCmdCopyImageToBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003001 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01260);
3002 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003003 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
3004 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", VALIDATION_ERROR_01251);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003005 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003006 "vkCmdCopyImageToBuffer()");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003007 }
3008 return skip;
3009}
3010
3011void PreCallRecordCmdCopyImageToBuffer(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *src_image_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003012 BUFFER_STATE *dst_buffer_state, uint32_t region_count, const VkBufferImageCopy *regions,
3013 VkImageLayout src_image_layout) {
3014 // Make sure that all image slices are updated to correct layout
3015 for (uint32_t i = 0; i < region_count; ++i) {
3016 SetImageLayout(device_data, cb_node, src_image_state, regions[i].imageSubresource, src_image_layout);
3017 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003018 // Update bindings between buffer/image and cmd buffer
3019 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003020 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003021
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003022 std::function<bool()> function = [=]() {
3023 return ValidateImageMemoryIsValid(device_data, src_image_state, "vkCmdCopyImageToBuffer()");
3024 };
3025 cb_node->validate_functions.push_back(function);
3026 function = [=]() {
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003027 SetBufferMemoryValid(device_data, dst_buffer_state, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003028 return false;
3029 };
3030 cb_node->validate_functions.push_back(function);
3031
3032 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYIMAGETOBUFFER);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003033}
3034
3035bool PreCallValidateCmdCopyBufferToImage(layer_data *device_data, VkImageLayout dstImageLayout, GLOBAL_CB_NODE *cb_node,
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003036 BUFFER_STATE *src_buffer_state, IMAGE_STATE *dst_image_state, uint32_t regionCount,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003037 const VkBufferImageCopy *pRegions, const char *func_name) {
3038 const debug_report_data *report_data = core_validation::GetReportData(device_data);
3039 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
3040
3041 // Validate command buffer state
3042 if (CB_RECORDING != cb_node->state) {
3043 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3044 (uint64_t)cb_node->commandBuffer, __LINE__, VALIDATION_ERROR_01240, "DS",
3045 "Cannot call vkCmdCopyBufferToImage() on command buffer which is not in recording state. %s.",
3046 validation_error_map[VALIDATION_ERROR_01240]);
3047 } else {
3048 skip |= ValidateCmdSubpassState(device_data, cb_node, CMD_COPYBUFFERTOIMAGE);
3049 }
3050
3051 // Command pool must support graphics, compute, or transfer operations
3052 auto pPool = GetCommandPoolNode(device_data, cb_node->createInfo.commandPool);
3053 VkQueueFlags queue_flags = GetPhysDevProperties(device_data)->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
3054 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
3055 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3056 (uint64_t)cb_node->createInfo.commandPool, __LINE__, VALIDATION_ERROR_01241, "DS",
3057 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
3058 "or transfer capabilities. %s.",
3059 validation_error_map[VALIDATION_ERROR_01241]);
3060 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07003061 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003062 VALIDATION_ERROR_01228);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003063 skip |= ValidtateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003064 VALIDATION_ERROR_01227);
3065 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
3066 VALIDATION_ERROR_01232);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003067 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02535);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003068 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_02536);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003069 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, VALIDATION_ERROR_01230,
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003070 "vkCmdCopyBufferToImage()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
3071 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, VALIDATION_ERROR_01231,
3072 "vkCmdCopyBufferToImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003073 skip |= insideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01242);
3074 for (uint32_t i = 0; i < regionCount; ++i) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06003075 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
3076 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", VALIDATION_ERROR_01234);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003077 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
3078 "vkCmdCopyBufferToImage()");
3079 }
3080 return skip;
3081}
3082
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003083void PreCallRecordCmdCopyBufferToImage(layer_data *device_data, GLOBAL_CB_NODE *cb_node, BUFFER_STATE *src_buffer_state,
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003084 IMAGE_STATE *dst_image_state, uint32_t region_count, const VkBufferImageCopy *regions,
3085 VkImageLayout dst_image_layout) {
3086 // Make sure that all image slices are updated to correct layout
3087 for (uint32_t i = 0; i < region_count; ++i) {
3088 SetImageLayout(device_data, cb_node, dst_image_state, regions[i].imageSubresource, dst_image_layout);
3089 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003090 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07003091 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003092 std::function<bool()> function = [=]() {
3093 SetImageMemoryValid(device_data, dst_image_state, true);
3094 return false;
3095 };
3096 cb_node->validate_functions.push_back(function);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07003097 function = [=]() { return ValidateBufferMemoryIsValid(device_data, src_buffer_state, "vkCmdCopyBufferToImage()"); };
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07003098 cb_node->validate_functions.push_back(function);
3099
3100 core_validation::UpdateCmdBufferLastCmd(cb_node, CMD_COPYBUFFERTOIMAGE);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07003101}
Mike Weiblen672b58b2017-02-21 14:32:53 -07003102
3103bool PreCallValidateGetImageSubresourceLayout(layer_data *device_data, VkImage image, const VkImageSubresource *pSubresource) {
3104 const auto report_data = core_validation::GetReportData(device_data);
3105 bool skip = false;
3106 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
3107
3108 // VU 00733: The aspectMask member of pSubresource must only have a single bit set
3109 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
3110 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
3111 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003112 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3113 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00733, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003114 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set. %s",
3115 validation_error_map[VALIDATION_ERROR_00733]);
3116 }
3117
3118 IMAGE_STATE *image_entry = GetImageState(device_data, image);
3119 if (!image_entry) {
3120 return skip;
3121 }
3122
3123 // VU 00732: image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
3124 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003125 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3126 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00732, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003127 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR. %s",
3128 validation_error_map[VALIDATION_ERROR_00732]);
3129 }
3130
3131 // VU 00739: mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
3132 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003133 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3134 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00739, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003135 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d. %s",
3136 pSubresource->mipLevel, image_entry->createInfo.mipLevels, validation_error_map[VALIDATION_ERROR_00739]);
3137 }
3138
3139 // VU 00740: arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
3140 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003141 skip |=
3142 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3143 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00740, "IMAGE",
3144 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d. %s",
3145 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers, validation_error_map[VALIDATION_ERROR_00740]);
Mike Weiblen672b58b2017-02-21 14:32:53 -07003146 }
3147
3148 // VU 00741: subresource's aspect must be compatible with image's format.
3149 const VkFormat img_format = image_entry->createInfo.format;
3150 if (vk_format_is_color(img_format)) {
3151 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
3152 skip |= log_msg(
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003153 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3154 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00741, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003155 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR. %s",
3156 validation_error_map[VALIDATION_ERROR_00741]);
3157 }
3158 } else if (vk_format_is_depth_or_stencil(img_format)) {
3159 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06003160 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3161 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_00741, "IMAGE",
Mike Weiblen672b58b2017-02-21 14:32:53 -07003162 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
3163 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT. %s",
3164 validation_error_map[VALIDATION_ERROR_00741]);
3165 }
3166 }
3167 return skip;
3168}