blob: 1c645435ef0756aa3671e3a443f41a93b89652d8 [file] [log] [blame]
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001/* Copyright (c) 2015-2021 The Khronos Group Inc.
2 * Copyright (c) 2015-2021 Valve Corporation
3 * Copyright (c) 2015-2021 LunarG, Inc.
4 * Copyright (C) 2015-2021 Google Inc.
Tony-LunarG5a066372021-01-21 10:31:34 -07005 * Modifications Copyright (C) 2020-2021 Advanced Micro Devices, Inc. All rights reserved.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07006 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060020 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070021 * Shannon McPherson <shannon@lunarg.com>
Tobias Hector6663c9b2020-11-05 10:18:02 +000022 * Author: Tobias Hector <tobias.hector@amd.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070023 */
24
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Jeremy Gebben579aaca2021-02-15 13:36:18 -070029#include <iostream>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070040#include "core_error_location.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070041#include "shader_validation.h"
42#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070043#include "buffer_validation.h"
Jeremy Gebben7ba56152021-06-18 10:40:10 -060044#include "sync_utils.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070045#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070046
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070047// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070048static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070049 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070050 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
51 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
53 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
54 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
55 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
56 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070057 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070058 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
59 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
60 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
61 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
62 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070063 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070064 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
65 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
66 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
67 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
68 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070069 {"00197", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070070 "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
71 "VUID-vkCmdCopyImageToBuffer-imageOffset-00197",
72 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00197",
73 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
74 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070075 {"00198", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070076 "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
77 "VUID-vkCmdCopyImageToBuffer-imageOffset-00198",
78 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00198",
79 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
80 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070081 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070082 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
83 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
84 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
85 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
86 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070087 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070088 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
89 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
90 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
91 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
92 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070093 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070094 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
95 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
96 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
97 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
98 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070099 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700100 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
101 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
102 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
103 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
104 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700105 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700106 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
107 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
108 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
109 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
110 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700111 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700112 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
113 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
114 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
115 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
116 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700117 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700118 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
119 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
120 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
121 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
122 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700123 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700124 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
125 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
126 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
127 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
128 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700129 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700130 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
131 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
132 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
133 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
134 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700135 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700136 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
137 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
138 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
139 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
140 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700141 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700142 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
143 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
144 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
145 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
146 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700147 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700148 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
149 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
150 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
151 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
152 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700153 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700154 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
155 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
156 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
157 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800158 }},
159 {"04052", {
160 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
161 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
162 "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04052",
163 "VUID-VkCopyImageToBufferInfo2KHR-commandBuffer-04052",
164 }},
165 {"04053", {
166 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
167 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
168 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-04053",
169 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700170 }}
171 };
172 // clang-format on
173
174 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700175 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
176 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700177 return copy_imagebuffer_vuid.at(id).at(index);
178}
179
David McFarland2853f2f2020-11-30 15:50:39 -0400180// Transfer VkImageSubresourceRange into VkImageSubresourceLayers struct
181static VkImageSubresourceLayers LayersFromRange(const VkImageSubresourceRange &subresource_range) {
182 VkImageSubresourceLayers subresource_layers;
183 subresource_layers.aspectMask = subresource_range.aspectMask;
184 subresource_layers.baseArrayLayer = subresource_range.baseArrayLayer;
185 subresource_layers.layerCount = subresource_range.layerCount;
186 subresource_layers.mipLevel = subresource_range.baseMipLevel;
187 return subresource_layers;
188}
189
John Zulauff660ad62019-03-23 07:16:05 -0600190// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
191static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
192 VkImageSubresourceRange subresource_range;
193 subresource_range.aspectMask = subresource_layers.aspectMask;
194 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
195 subresource_range.layerCount = subresource_layers.layerCount;
196 subresource_range.baseMipLevel = subresource_layers.mipLevel;
197 subresource_range.levelCount = 1;
198 return subresource_range;
199}
200
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700201static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200202 switch (layout) {
203 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
204 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
205 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
206
207 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
208 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
209 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
210
211 default:
212 return layout;
213 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700214}
215
216static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200217 switch (layout) {
218 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
219 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
220 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
221
222 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
223 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
224 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
225
226 default:
227 return layout;
228 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700229}
230
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700231static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
232 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
233 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
234 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
235 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
236 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
237 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
238 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
239 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
240 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
241 }
242 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
243 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
244 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
245 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
246 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
247 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
248 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
249 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
250 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
251 }
252 }
253 return layout;
254}
255
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700256static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
257 bool matches = (a == b);
258 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700259 a = NormalizeSynchronization2Layout(aspect_mask, a);
260 b = NormalizeSynchronization2Layout(aspect_mask, b);
261 matches = (a == b);
262 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200263 // Relaxed rules when referencing *only* the depth or stencil aspects.
264 // When accessing both, normalize layouts for aspects separately.
265 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
266 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
267 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
268 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700269 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
270 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
271 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
272 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700273 }
274 }
275 return matches;
276}
277
278// Utility type for ForRange callbacks
279struct LayoutUseCheckAndMessage {
280 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
281 const ImageSubresourceLayoutMap *layout_map;
282 const VkImageAspectFlags aspect_mask;
283 const char *message;
284 VkImageLayout layout;
285
286 LayoutUseCheckAndMessage() = delete;
287 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
288 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
289 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
290 message = nullptr;
291 layout = kInvalidLayout; // Success status
292 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
293 message = "previous known";
294 layout = current_layout;
295 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
296 // To check the relaxed rule matching we need to see how the initial use was used
297 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
298 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
299 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
300 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
301 message = "previously used";
302 layout = initial_layout;
303 }
304 }
305 return layout == kInvalidLayout;
306 }
307};
308
locke-lunarg540b2252020-08-03 13:23:36 -0600309bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600310 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600311 return true;
312 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600313 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600314 return false;
315 }
locke-lunarg540b2252020-08-03 13:23:36 -0600316 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
317 return false;
318 }
319
320 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600321 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600322 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600323 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600324 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600325 }
326
327 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600328 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600329 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600330 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600331 }
332
333 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600334 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600335 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600336 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600337 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600338 }
339
340 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600341 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600342 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600343 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600344 }
locke-lunargdc287022020-08-21 12:03:57 -0600345 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600346}
347
Dave Houltond9611312018-11-19 17:03:36 -0700348uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
349 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700350 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700351}
352
353uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
354
355uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
356
John Zulauf2d60a452021-03-04 15:12:03 -0700357bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600358 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state.image());
John Zulauf2076e812020-01-08 14:55:54 -0700359 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700360 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
361 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
362
John Zulauf2076e812020-01-08 14:55:54 -0700363 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
364
365 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700366 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700367 return false;
368 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700369
John Zulauf79f06582021-02-27 18:38:39 -0700370 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700371 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700372 }
373 return true;
374}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700375
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600376// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600377void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600378 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
379 VkImageLayout expected_layout) {
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600380 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state);
John Zulauff660ad62019-03-23 07:16:05 -0600381 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600382 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600383 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700384 }
John Zulaufd13b38e2021-03-05 08:17:38 -0700385 for (const auto *alias_state : image_state.aliasing_images) {
386 assert(alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700387 // The map state of the aliases should all be in sync, so no need to check the return value
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600388 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700389 assert(subresource_map);
390 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
391 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700392}
John Zulauff660ad62019-03-23 07:16:05 -0600393
394// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600395void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600396 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500397 return;
398 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500399 IMAGE_STATE *image_state = view_state.image_state.get();
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600400 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700401 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulaufd13b38e2021-03-05 08:17:38 -0700402 for (const auto *alias_state : image_state->aliasing_images) {
403 assert(alias_state);
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600404 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700405 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
406 }
John Zulauff660ad62019-03-23 07:16:05 -0600407}
408
409// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600410void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600411 const VkImageSubresourceRange &range, VkImageLayout layout) {
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600412 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state);
John Zulauff660ad62019-03-23 07:16:05 -0600413 assert(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600414 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, image_state.NormalizeSubresourceRange(range), layout);
John Zulaufd13b38e2021-03-05 08:17:38 -0700415 for (const auto *alias_state : image_state.aliasing_images) {
416 assert(alias_state);
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600417 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700418 assert(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600419 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, alias_state->NormalizeSubresourceRange(range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700420 }
John Zulauff660ad62019-03-23 07:16:05 -0600421}
422
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600423void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600424 VkImageLayout layout) {
425 const IMAGE_STATE *image_state = GetImageState(image);
426 if (!image_state) return;
427 SetImageInitialLayout(cb_node, *image_state, range, layout);
428};
429
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600430void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600431 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
432 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600433}
Dave Houltonddd65c52018-05-08 14:58:01 -0600434
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600435// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700436void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
437 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500438 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600439
John Zulauff660ad62019-03-23 07:16:05 -0600440 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600441 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
442 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600443 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state.create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
Dave Houltonddd65c52018-05-08 14:58:01 -0600444 sub_range.baseArrayLayer = 0;
445 sub_range.layerCount = image_state->createInfo.extent.depth;
446 }
447
Piers Daniell4fde9b72019-11-27 16:19:46 -0700448 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
449 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
450 SetImageLayout(cb_node, *image_state, sub_range, layout);
451 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
452 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
453 } else {
454 SetImageLayout(cb_node, *image_state, sub_range, layout);
455 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600456}
457
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700458bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
459 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700460 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600461 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100462 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700463 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100464 const char *vuid;
465 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700466 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100467
468 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600469 LogObjectList objlist(image);
470 objlist.add(renderpass);
471 objlist.add(framebuffer);
472 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700473 skip |=
474 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
475 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
476 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
477 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100478 return skip;
479 }
480
481 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700482 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200483 if (stencil_usage_info) {
484 image_usage |= stencil_usage_info->stencilUsage;
485 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100486
487 // Check for layouts that mismatch image usages in the framebuffer
488 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800489 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600490 LogObjectList objlist(image);
491 objlist.add(renderpass);
492 objlist.add(framebuffer);
493 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700494 skip |= LogError(objlist, vuid,
495 "%s: Layout/usage mismatch for attachment %u in %s"
496 " - the %s is %s but the image attached to %s via %s"
497 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
498 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
499 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
500 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100501 }
502
503 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
504 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800505 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600506 LogObjectList objlist(image);
507 objlist.add(renderpass);
508 objlist.add(framebuffer);
509 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700510 skip |= LogError(objlist, vuid,
511 "%s: Layout/usage mismatch for attachment %u in %s"
512 " - the %s is %s but the image attached to %s via %s"
513 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
514 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
515 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
516 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100517 }
518
519 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800520 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600521 LogObjectList objlist(image);
522 objlist.add(renderpass);
523 objlist.add(framebuffer);
524 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700525 skip |= LogError(objlist, vuid,
526 "%s: Layout/usage mismatch for attachment %u in %s"
527 " - the %s is %s but the image attached to %s via %s"
528 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
529 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
530 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
531 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100532 }
533
534 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800535 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600536 LogObjectList objlist(image);
537 objlist.add(renderpass);
538 objlist.add(framebuffer);
539 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700540 skip |= LogError(objlist, vuid,
541 "%s: Layout/usage mismatch for attachment %u in %s"
542 " - the %s is %s but the image attached to %s via %s"
543 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
544 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
545 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
546 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100547 }
548
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600549 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100550 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
551 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
552 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
553 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
554 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800555 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600556 LogObjectList objlist(image);
557 objlist.add(renderpass);
558 objlist.add(framebuffer);
559 objlist.add(image_view);
560 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700561 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700562 " - the %s is %s but the image attached to %s via %s"
563 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700564 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700565 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
566 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100567 }
568 } else {
569 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
570 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
571 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
572 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600573 LogObjectList objlist(image);
574 objlist.add(renderpass);
575 objlist.add(framebuffer);
576 objlist.add(image_view);
577 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700578 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700579 " - the %s is %s but the image attached to %s via %s"
580 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700581 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700582 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
583 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100584 }
585 }
586 return skip;
587}
588
John Zulauf17a01bb2019-08-09 16:41:19 -0600589bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700590 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600591 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600592 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700593 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
594 auto const &framebuffer_info = framebuffer_state->createInfo;
595 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100596
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600597 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass();
598 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100599
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700600 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600601 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700602 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700603 }
John Zulauf8e308292018-09-21 11:34:37 -0600604
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700605 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800606 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700607 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100608 }
609
Tobias Hectorc9057422019-07-23 12:15:52 +0100610 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700611 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
612 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100613 auto image_view = attachments[i];
614 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100615
Tobias Hectorc9057422019-07-23 12:15:52 +0100616 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600617 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600618 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600619 objlist.add(image_view);
620 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700621 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600622 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700623 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100624 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100625 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100626
627 const VkImage image = view_state->create_info.image;
628 const IMAGE_STATE *image_state = GetImageState(image);
629
630 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600631 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600632 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600633 objlist.add(image_view);
634 objlist.add(image);
635 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700636 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600637 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700638 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100639 continue;
640 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700641 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
642 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100643
Piers Daniell7f894f62020-01-09 16:33:48 -0700644 // Default to expecting stencil in the same layout.
645 auto attachment_stencil_initial_layout = attachment_initial_layout;
646
647 // If a separate layout is specified, look for that.
648 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700649 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700650 if (attachment_description_stencil_layout) {
651 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
652 }
653
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200654 const ImageSubresourceLayoutMap *subresource_map = nullptr;
655 bool has_queried_map = false;
656 bool subres_skip = false;
Tobias Hectorc9057422019-07-23 12:15:52 +0100657
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200658 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
659 VkImageAspectFlags test_aspect = 1u << aspect_index;
660 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
661 continue;
662 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700663
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200664 // Allow for differing depth and stencil layouts
665 VkImageLayout check_layout = attachment_initial_layout;
666 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
667 check_layout = attachment_stencil_initial_layout;
668 }
669
670 if (check_layout != VK_IMAGE_LAYOUT_UNDEFINED) { // If no layout information for image yet, will be checked at QueueSubmit time
671 if (!has_queried_map) {
672 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
673 // in common with the non-const version.)
674 // The lookup is expensive, so cache it.
675 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(image);
676 has_queried_map = true;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200677 }
John Zulauf5e617452019-11-19 14:44:16 -0700678
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200679 if (subresource_map) {
680 auto normalized_range = view_state->normalized_subresource_range;
681 normalized_range.aspectMask = test_aspect;
682 auto pos = subresource_map->Find(normalized_range);
683 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200684
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200685 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
686 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
687 const VkImageSubresource &subres = pos->subresource;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200688
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200689 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
690 subres_skip |= LogError(
691 device, kVUID_Core_DrawState_InvalidRenderpass,
692 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
693 "and the %s layout of the attachment is %s. The layouts must match, or the render "
694 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
695 i, string_VkImageLayout(check_layout), layout_check.message,
696 string_VkImageLayout(layout_check.layout));
697 }
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200698 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100699 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700700 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100701 }
702
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200703 skip |= subres_skip;
704
Tobias Hectorc9057422019-07-23 12:15:52 +0100705 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
706 framebuffer, render_pass, i, "initial layout");
707
708 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
709 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100710 }
711
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700712 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
713 auto &subpass = render_pass_info->pSubpasses[j];
714 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100715 auto &attachment_ref = subpass.pInputAttachments[k];
716 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
717 auto image_view = attachments[attachment_ref.attachment];
718 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100719
Tobias Hectorc9057422019-07-23 12:15:52 +0100720 if (view_state) {
721 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700722 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
723 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100724 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100725 }
726 }
727 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100728
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700729 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100730 auto &attachment_ref = subpass.pColorAttachments[k];
731 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
732 auto image_view = attachments[attachment_ref.attachment];
733 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100734
Tobias Hectorc9057422019-07-23 12:15:52 +0100735 if (view_state) {
736 auto image = view_state->create_info.image;
737 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
738 framebuffer, render_pass, attachment_ref.attachment,
739 "color attachment layout");
740 if (subpass.pResolveAttachments) {
741 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
742 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
743 attachment_ref.attachment, "resolve attachment layout");
744 }
745 }
746 }
747 }
748
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700749 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100750 auto &attachment_ref = *subpass.pDepthStencilAttachment;
751 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
752 auto image_view = attachments[attachment_ref.attachment];
753 auto view_state = GetImageViewState(image_view);
754
755 if (view_state) {
756 auto image = view_state->create_info.image;
757 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
758 framebuffer, render_pass, attachment_ref.attachment,
759 "input attachment layout");
760 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100761 }
762 }
763 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700764 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600765 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700766}
767
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600768void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700769 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700770 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600771 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600772 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700773 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700774 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700775 if (attachment_reference_stencil_layout) {
776 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
777 }
778
779 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600780 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700781 }
782}
783
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600784void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
785 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700786 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700787
788 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700789 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700790 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700791 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700792 }
793 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700794 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700795 }
796 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700797 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700798 }
799 }
800}
801
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700802// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
803// 1. Transition into initialLayout state
804// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600805void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700806 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700807 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700808 auto const rpci = render_pass_state->createInfo.ptr();
809 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600810 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600811 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700812 IMAGE_STATE *image_state = view_state->image_state.get();
813 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700814 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700815 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700816 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700817 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
818 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
819 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
820 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
821 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
822 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
823 } else {
824 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700825 }
John Zulauf8e308292018-09-21 11:34:37 -0600826 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700827 }
828 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700829 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700830}
831
Dave Houlton10b39482017-03-16 13:18:15 -0600832bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600833 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600834 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600835 }
836 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600837 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600838 }
839 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600840 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600841 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800842 if (0 != (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700843 if (FormatPlaneCount(format) == 1) return false;
844 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600845 return true;
846}
847
Mike Weiblen62d08a32017-03-07 22:18:27 -0700848// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700849bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700850 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700851 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700852 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700853 switch (layout) {
854 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700855 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700856 break;
857 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700858 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700859 break;
860 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700861 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700862 break;
863 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700864 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700865 break;
866 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700867 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700868 break;
869 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700870 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700871 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600872 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700873 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500874 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700875 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700876 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700877 break;
878 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700879 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700880 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700881 default:
882 // Other VkImageLayout values do not have VUs defined in this context.
883 break;
884 }
885
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700886 if (is_error) {
887 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
888
889 skip |=
890 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
891 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700892 }
893 return skip;
894}
895
896// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700897template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700898bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700899 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700900 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700901 using sync_vuid_maps::GetImageBarrierVUID;
902 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200903 // Scoreboard for checking for duplicate and inconsistent barriers to images
904 struct ImageBarrierScoreboardEntry {
905 uint32_t index;
906 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
907 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700908 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +0200909 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700910 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
911 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
912 // when creating maps full of maps.
913 struct ImageBarrierScoreboardSubresMap {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700914 layer_data::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700915 };
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700916 using ImageBarrierScoreboardImageMap = layer_data::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
Petr Krausad0096a2019-08-09 18:35:04 +0200917
John Zulauf463c51e2018-05-31 13:29:20 -0600918 // Scoreboard for duplicate layout transition barriers within the list
919 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
920 ImageBarrierScoreboardImageMap layout_transitions;
921
Mike Weiblen62d08a32017-03-07 22:18:27 -0700922 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700923 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200924 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700925
John Zulauf463c51e2018-05-31 13:29:20 -0600926 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
927 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
928 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200929 if (img_barrier.oldLayout != img_barrier.newLayout) {
930 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
931 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600932 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700933 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +0200934 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600935 if (subres_it != subres_map.end()) {
936 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700937 auto entry_layout =
938 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
939 auto old_layout =
940 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
941 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200942 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700943 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700944 skip = LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600945 cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700946 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600947 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
948 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700949 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +0200950 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
951 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600952 }
953 entry = new_entry;
954 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200955 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600956 }
957 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700958 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600959 }
960 }
961
Petr Krausad0096a2019-08-09 18:35:04 +0200962 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600963 if (image_state) {
964 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700965 skip |=
966 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
967 skip |=
968 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600969
970 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
971 if (image_state->layout_locked) {
972 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700973 skip |= LogError(
974 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700975 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600976 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700977 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
978 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600979 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600980
John Zulaufa4472282019-08-22 14:44:34 -0600981 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700982 const VkFormat image_format = image_create_info.format;
983 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600984 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700985 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700986 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700987 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600988 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700989 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
990 skip |= LogError(img_barrier.image, vuid,
991 "%s references %s of format %s that must have either the depth or stencil "
992 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
993 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
994 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600995 }
996 } else {
997 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
998 if ((aspect_mask & ds_mask) != (ds_mask)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700999 auto error = device_extensions.vk_khr_separate_depth_stencil_layouts
1000 ? ImageError::kNotSeparateDepthAndStencilAspect
1001 : ImageError::kNotDepthAndStencilAspect;
1002 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -07001003 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001004 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001005 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001006 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001007 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -06001008 }
Dave Houltonb3f4b282018-02-22 16:25:16 -07001009 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001010 }
John Zulauff660ad62019-03-23 07:16:05 -06001011
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001012 const auto *subresource_map = cb_state->GetImageSubresourceLayoutMap(img_barrier.image);
Petr Krausad0096a2019-08-09 18:35:04 +02001013 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001014 // TODO: Set memory invalid which is in mem_tracker currently
1015 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1016 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001017 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001018 bool subres_skip = false;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +02001019
1020 // Validate aspects in isolation.
1021 // This is required when handling separate depth-stencil layouts.
1022 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
1023 VkImageAspectFlags test_aspect = 1u << aspect_index;
1024 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
1025 continue;
1026 }
1027
1028 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
1029 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
1030 normalized_isr.aspectMask = test_aspect;
1031
1032 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
1033 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
1034 const auto &value = *pos;
1035 auto old_layout =
1036 NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
1037 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
1038 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
1039 subres_skip =
1040 LogError(cb_state->commandBuffer(), vuid,
1041 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
1042 "%s layout is %s.",
1043 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1044 value.subresource.aspectMask, value.subresource.mipLevel, value.subresource.arrayLayer,
1045 string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
1046 string_VkImageLayout(layout_check.layout));
1047 }
John Zulauff660ad62019-03-23 07:16:05 -06001048 }
John Zulauf5e617452019-11-19 14:44:16 -07001049 }
John Zulauff660ad62019-03-23 07:16:05 -06001050 skip |= subres_skip;
1051 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001052
1053 // checks color format and (single-plane or non-disjoint)
1054 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1055 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001056 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001057 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001058 auto error = device_extensions.vk_khr_sampler_ycbcr_conversion ? ImageError::kNotColorAspect
1059 : ImageError::kNotColorAspectYcbcr;
1060 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -07001061 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001062 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -07001063 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001064 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001065 string_VkFormat(image_format), aspect_mask);
1066 }
1067 }
1068
1069 VkImageAspectFlags valid_disjoint_mask =
1070 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
sfricke-samsung71bc6572020-04-29 15:49:43 -07001071 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001072 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001073 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1074 skip |= LogError(img_barrier.image, vuid,
1075 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -07001076 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001077 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001078 string_VkFormat(image_format), aspect_mask);
1079 }
1080
1081 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001082 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1083 skip |= LogError(img_barrier.image, vuid,
1084 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -07001085 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001086 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001087 string_VkFormat(image_format), aspect_mask);
1088 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001089 }
1090 }
1091 return skip;
1092}
1093
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001094template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001095bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001096 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001097 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001098 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001099 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001100 if (!IsTransferOp(barrier)) {
1101 return skip;
1102 }
1103 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001104 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001105 const auto found = barrier_sets.release.find(barrier);
1106 if (found != barrier_sets.release.cend()) {
1107 barrier_record = &(*found);
1108 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001109 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001110 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001111 const auto found = barrier_sets.acquire.find(barrier);
1112 if (found != barrier_sets.acquire.cend()) {
1113 barrier_record = &(*found);
1114 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001115 }
1116 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001117 if (barrier_record != nullptr) {
1118 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001119 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001120 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1121 " duplicates existing barrier recorded in this command buffer.",
1122 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1123 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1124 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001125 return skip;
1126}
1127
John Zulaufa4472282019-08-22 14:44:34 -06001128VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1129 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1130}
1131
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001132VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1133 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1134}
1135
John Zulaufa4472282019-08-22 14:44:34 -06001136const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1137 return device_state.GetImageState(barrier.image);
1138}
1139
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001140const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1141 return device_state.GetImageState(barrier.image);
1142}
1143
John Zulaufa4472282019-08-22 14:44:34 -06001144VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1145 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1146}
1147
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001148VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1149 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1150}
1151
John Zulaufa4472282019-08-22 14:44:34 -06001152const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1153 return device_state.GetBufferState(barrier.buffer);
1154}
1155
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001156const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1157 return device_state.GetBufferState(barrier.buffer);
1158}
John Zulaufa4472282019-08-22 14:44:34 -06001159
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001160template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001161void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001162 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001163 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001164 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001165 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001166 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001167 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001168 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001169 }
John Zulaufa4472282019-08-22 14:44:34 -06001170
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001171 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1172 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001173 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1174 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001175 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1176
1177 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001178 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1179 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1180 auto handle_state = BarrierHandleState(*this, barrier);
1181 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1182 if (!mode_concurrent) {
1183 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001184 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001185 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001186 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1187 const QUEUE_STATE *queue_state) {
1188 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001189 src_queue_family, dst_queue_family);
1190 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001191 }
1192 }
1193}
1194
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001195// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001196template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001197bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001198 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1199 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001200 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1201 using sync_vuid_maps::GetImageBarrierVUID;
1202 using sync_vuid_maps::ImageError;
1203
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001204 bool skip = false;
1205 const auto *fb_state = framebuffer;
1206 assert(fb_state);
1207 const auto img_bar_image = img_barrier.image;
1208 bool image_match = false;
1209 bool sub_image_found = false; // Do we find a corresponding subpass description
1210 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1211 uint32_t attach_index = 0;
1212 // Verify that a framebuffer image matches barrier image
1213 const auto attachment_count = fb_state->createInfo.attachmentCount;
1214 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001215 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001216 if (view_state && (img_bar_image == view_state->create_info.image)) {
1217 image_match = true;
1218 attach_index = attachment;
1219 break;
1220 }
1221 }
1222 if (image_match) { // Make sure subpass is referring to matching attachment
1223 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1224 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1225 sub_image_found = true;
1226 }
1227 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1228 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1229 if (resolve && resolve->pDepthStencilResolveAttachment &&
1230 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1231 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1232 sub_image_found = true;
1233 }
1234 }
1235 if (!sub_image_found) {
1236 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1237 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1238 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1239 sub_image_found = true;
1240 break;
1241 }
1242 if (!sub_image_found && sub_desc.pResolveAttachments &&
1243 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1244 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1245 sub_image_found = true;
1246 break;
1247 }
1248 }
1249 }
1250 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001251 auto img_loc = loc.dot(Field::image);
1252 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1253 skip |=
1254 LogError(rp_handle, vuid,
1255 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1256 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1257 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001258 }
1259 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001260 auto img_loc = loc.dot(Field::image);
1261 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001262 skip |= LogError(fb_state->framebuffer(), vuid, "%s Barrier for %s does not match an image from the current %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001263 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001264 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001265 }
1266 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001267 auto layout_loc = loc.dot(Field::oldLayout);
1268 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001269 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001270 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001271 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001272 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001273 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1274 } else {
1275 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1276 LogObjectList objlist(rp_handle);
1277 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001278 auto layout_loc = loc.dot(Field::oldLayout);
1279 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1280 skip |= LogError(objlist, vuid,
1281 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001282 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001283 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001284 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1285 string_VkImageLayout(img_barrier.oldLayout));
1286 }
1287 }
1288 return skip;
1289}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001290// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001291template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001292 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1293 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1294 const VkImageMemoryBarrier &img_barrier,
1295 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001296template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001297 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1298 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1299 const VkImageMemoryBarrier2KHR &img_barrier,
1300 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001301
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001302template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001303void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001304 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001305 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1306 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1307 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1308 const auto active_subpass = cb_state->activeSubpass;
1309 const auto rp_state = cb_state->activeRenderPass;
1310 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001311 // Secondary CB case w/o FB specified delay validation
1312 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001313 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001314 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001315 cb_state->cmd_execute_commands_functions.emplace_back(
1316 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1317 const FRAMEBUFFER_STATE *fb) {
1318 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1319 render_pass, barrier, primary_cb);
1320 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001321 }
1322}
1323
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001324void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001325 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1326 const VkImageMemoryBarrier *pImageMemBarriers) {
1327 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001328 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001329 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1330 }
1331 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001332 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001333 const auto &img_barrier = pImageMemBarriers[i];
1334 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1335 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1336 }
1337}
1338
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001339void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001340 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001341 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001342 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1343 }
1344 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001345 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001346 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1347 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1348 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1349 }
1350}
1351
1352template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001353bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001354 const char *operation, const TransferBarrier &barrier,
1355 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001356 // Record to the scoreboard or report that we have a duplication
1357 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001358 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001359 if (!inserted.second && inserted.first->second != cb_state) {
1360 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001361 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001362 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001363 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001364 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001365 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1366 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001367 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001368 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001369 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001370 }
1371 return skip;
1372}
1373
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001374template <typename TransferBarrier>
1375bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1376 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1377 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001378 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001379 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001380 const char *barrier_name = TransferBarrier::BarrierName();
1381 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001382 // No release should have an extant duplicate (WARNING)
1383 for (const auto &release : cb_barriers.release) {
1384 // Check the global pending release barriers
1385 const auto set_it = global_release_barriers.find(release.handle);
1386 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001387 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001388 const auto found = set_for_handle.find(release);
1389 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001390 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001391 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1392 " to dstQueueFamilyIndex %" PRIu32
1393 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1394 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1395 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001396 }
1397 }
1398 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1399 }
1400 // Each acquire must have a matching release (ERROR)
1401 for (const auto &acquire : cb_barriers.acquire) {
1402 const auto set_it = global_release_barriers.find(acquire.handle);
1403 bool matching_release_found = false;
1404 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001405 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001406 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1407 }
1408 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001409 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001410 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1411 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1412 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1413 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001414 }
1415 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1416 }
1417 return skip;
1418}
1419
John Zulauf3b04ebd2019-07-18 14:08:11 -06001420bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001421 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1422 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001423 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001424 skip |=
1425 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1426 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1427 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001428 return skip;
1429}
1430
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001431template <typename TransferBarrier>
1432void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1433 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001434 // Add release barriers from this submit to the global map
1435 for (const auto &release : cb_barriers.release) {
1436 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1437 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1438 global_release_barriers[release.handle].insert(release);
1439 }
1440
1441 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1442 for (const auto &acquire : cb_barriers.acquire) {
1443 // NOTE: We're not using [] because we don't want to create entries for missing releases
1444 auto set_it = global_release_barriers.find(acquire.handle);
1445 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001446 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001447 set_for_handle.erase(acquire);
1448 if (set_for_handle.size() == 0) { // Clean up empty sets
1449 global_release_barriers.erase(set_it);
1450 }
1451 }
1452 }
1453}
1454
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001455void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001456 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1457 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1458 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001459}
1460
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001461template <typename ImgBarrier>
1462void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1463 // For ownership transfers, the barrier is specified twice; as a release
1464 // operation on the yielding queue family, and as an acquire operation
1465 // on the acquiring queue family. This barrier may also include a layout
1466 // transition, which occurs 'between' the two operations. For validation
1467 // purposes it doesn't seem important which side performs the layout
1468 // transition, but it must not be performed twice. We'll arbitrarily
1469 // choose to perform it as part of the acquire operation.
1470 //
1471 // However, we still need to record initial layout for the "initial layout" validation
1472 for (uint32_t i = 0; i < barrier_count; i++) {
1473 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001474 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001475 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001476 if (image_state) {
1477 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1478 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001479 }
1480}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001481// explictly instantiate this template so it can be used in core_validation.cpp
1482template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1483 const VkImageMemoryBarrier *barrier);
1484template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1485 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001486
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001487VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1488
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001489template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001490void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001491 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001492 if (enabled_features.synchronization2_features.synchronization2) {
1493 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1494 return;
1495 }
1496 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001497 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001498 const auto &image_create_info = image_state->createInfo;
1499
Mike Schuchardt2df08912020-12-15 16:28:09 -08001500 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag bit, where <extent.depth> and
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001501 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001502 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001503 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001504 normalized_isr.baseArrayLayer = 0;
1505 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1506 }
1507
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001508 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1509 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001510
1511 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001512 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001513 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1514 }
1515
John Zulauf2be3fe02019-12-30 09:48:02 -07001516 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001517 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001518 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001519 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001520 }
unknown86bcb3a2019-07-11 13:05:36 -06001521}
1522
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001523bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1524 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1525 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1526 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001527 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001528 assert(cb_node);
1529 assert(image_state);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001530 const auto image = image_state->image();
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001531 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001532
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001533 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image);
John Zulauff660ad62019-03-23 07:16:05 -06001534 if (subresource_map) {
1535 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001536 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001537 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1538 // the next "constant value" range
1539 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001540 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001541 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001542 subres_skip |= LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001543 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1544 "%s layout %s.",
1545 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1546 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1547 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001548 }
John Zulauf5e617452019-11-19 14:44:16 -07001549 }
John Zulauff660ad62019-03-23 07:16:05 -06001550 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001551 }
John Zulauff660ad62019-03-23 07:16:05 -06001552
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001553 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1554 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1555 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001556 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1557 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001558 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001559 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1560 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001561 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001562 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001563 if (image_state->shared_presentable) {
1564 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001565 skip |=
1566 LogError(device, layout_invalid_msg_code,
1567 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1568 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001569 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001570 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001571 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001572 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001573 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001574 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1575 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1576 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001577 }
1578 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001579 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001580}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001581bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001582 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1583 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001584 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001585 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1586 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1587}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001588
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001589void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001590 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001591 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1592 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001593
Mike Schuchardt2df08912020-12-15 16:28:09 -08001594 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001595 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001596 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001597 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001598 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001599 VkImageLayout stencil_layout = kInvalidLayout;
1600 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001601 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001602 if (attachment_description_stencil_layout) {
1603 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1604 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001605 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001606 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001607 }
1608 }
1609}
Dave Houltone19e20d2018-02-02 16:32:41 -07001610
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001611#ifdef VK_USE_PLATFORM_ANDROID_KHR
1612// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1613// This could also move into a seperate core_validation_android.cpp file... ?
1614
1615//
1616// AHB-specific validation within non-AHB APIs
1617//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001618bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001619 bool skip = false;
1620
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001621 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001622 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001623 if (0 != ext_fmt_android->externalFormat) {
1624 if (VK_FORMAT_UNDEFINED != create_info->format) {
1625 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001626 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1627 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1628 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001629 }
1630
1631 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001632 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1633 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1634 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001635 }
1636
1637 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001638 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1639 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001640 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001641 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001642 }
1643
1644 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001645 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1646 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1647 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001648 }
1649 }
1650
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001651 if ((0 != ext_fmt_android->externalFormat) &&
1652 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001653 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001654 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1655 ") which has "
1656 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1657 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001658 }
1659 }
1660
Dave Houltond9611312018-11-19 17:03:36 -07001661 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001662 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001663 skip |=
1664 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1665 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1666 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001667 }
1668 }
1669
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001670 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001671 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1672 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001673 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001674 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1675 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1676 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1677 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001678 }
1679
1680 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001681 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1682 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1683 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1684 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1685 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001686 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001687 }
1688
1689 return skip;
1690}
1691
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001692bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001693 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001694 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001695
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001696 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001697 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001698 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1699 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001700 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001701 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001702 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001703
Dave Houltond9611312018-11-19 17:03:36 -07001704 // Chain must include a compatible ycbcr conversion
1705 bool conv_found = false;
1706 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001707 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001708 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001709 auto ycbcr_state = GetSamplerYcbcrConversionState(ycbcr_conv_info->conversion);
1710 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001711 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001712 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001713 }
Dave Houltond9611312018-11-19 17:03:36 -07001714 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001715 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001716 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001717 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1718 "an externalFormat (%" PRIu64
1719 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1720 "with the same external format.",
1721 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001722 }
1723
1724 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001725 if (IsIdentitySwizzle(create_info->components) == false) {
1726 skip |= LogError(
1727 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1728 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1729 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1730 "= %s.",
1731 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1732 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001733 }
1734 }
Dave Houltond9611312018-11-19 17:03:36 -07001735
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001736 return skip;
1737}
1738
John Zulaufa26d3c82019-08-14 16:09:08 -06001739bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001740 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001741
John Zulaufa26d3c82019-08-14 16:09:08 -06001742 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001743 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001744 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001745 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1746 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1747 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1748 "bound to memory.");
1749 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001750 }
1751 return skip;
1752}
1753
1754#else
1755
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001756bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001757 return false;
1758}
1759
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001760bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001761
John Zulaufa26d3c82019-08-14 16:09:08 -06001762bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001763
1764#endif // VK_USE_PLATFORM_ANDROID_KHR
1765
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001766bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1767 bool skip = false;
1768
1769 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1770 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1771 const VkImageTiling image_tiling = pCreateInfo->tiling;
1772 const VkFormat image_format = pCreateInfo->format;
1773
1774 if (image_format == VK_FORMAT_UNDEFINED) {
1775 // VU 01975 states format can't be undefined unless an android externalFormat
1776#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001777 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001778 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1779 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1780 if (it != ahb_ext_formats_map.end()) {
1781 tiling_features = it->second;
1782 }
1783 }
1784#endif
1785 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1786 uint64_t drm_format_modifier = 0;
1787 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001788 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001789 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001790 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001791
1792 if (drm_explicit != nullptr) {
1793 drm_format_modifier = drm_explicit->drmFormatModifier;
1794 } else {
1795 // VUID 02261 makes sure its only explict or implict in parameter checking
1796 assert(drm_implicit != nullptr);
1797 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1798 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1799 }
1800 }
1801
1802 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1803 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1804 nullptr};
1805 format_properties_2.pNext = (void *)&drm_properties_list;
1806 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001807 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1808 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1809 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1810 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001811
1812 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1813 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1814 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1815 }
1816 }
1817 } else {
1818 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1819 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1820 : format_properties.optimalTilingFeatures;
1821 }
1822
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001823 // Lack of disjoint format feature support while using the flag
1824 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1825 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1826 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1827 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1828 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1829 string_VkFormat(pCreateInfo->format));
1830 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001831
1832 return skip;
1833}
1834
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001835bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001836 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001837 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001838
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001839 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001840 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001841 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1842 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001843 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1844 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001845 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001846 }
1847
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001848 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1849 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001850 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1851 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1852 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001853 }
1854
1855 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001856 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1857 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1858 "height (%d) and arrayLayers (%d) must be >= 6.",
1859 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001860 }
Dave Houlton130c0212018-01-29 13:39:56 -07001861 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001862
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001863 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001864 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1865 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1866 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001867 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001868 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1869 "device maxFramebufferWidth (%u).",
1870 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001871 }
1872
1873 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001874 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001875 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1876 "device maxFramebufferHeight (%u).",
1877 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001878 }
1879
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001880 VkImageCreateFlags sparseFlags =
1881 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1882 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1883 skip |= LogError(
1884 device, "VUID-VkImageCreateInfo-None-01925",
1885 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1886 }
1887
Mike Schuchardtc57de4a2021-07-20 17:26:32 -07001888 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001889 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1890 static_cast<float>(device_limits->maxFramebufferWidth) /
1891 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001892 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1893 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001894 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1895 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1896 "ceiling of device "
1897 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1898 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1899 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001900 }
1901
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001902 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1903 static_cast<float>(device_limits->maxFramebufferHeight) /
1904 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001905 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1906 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001907 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1908 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1909 "ceiling of device "
1910 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1911 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1912 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001913 }
1914 }
1915
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001916 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001917 VkResult result = VK_SUCCESS;
1918 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1919 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1920 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1921 &format_limits);
1922 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001923 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1924 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001925 if (modifier_list) {
1926 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001927 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001928 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001929 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001930 image_format_info.type = pCreateInfo->imageType;
1931 image_format_info.format = pCreateInfo->format;
1932 image_format_info.tiling = pCreateInfo->tiling;
1933 image_format_info.usage = pCreateInfo->usage;
1934 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001935 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001936
1937 result =
1938 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1939 format_limits = image_format_properties.imageFormatProperties;
1940
1941 /* The application gives a list of modifier and the driver
1942 * selects one. If one is wrong, stop there.
1943 */
1944 if (result != VK_SUCCESS) break;
1945 }
1946 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001947 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001948 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001949 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001950 image_format_info.type = pCreateInfo->imageType;
1951 image_format_info.format = pCreateInfo->format;
1952 image_format_info.tiling = pCreateInfo->tiling;
1953 image_format_info.usage = pCreateInfo->usage;
1954 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001955 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001956
1957 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1958 format_limits = image_format_properties.imageFormatProperties;
1959 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001960 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001961
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001962 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1963 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1964 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1965 if (result != VK_SUCCESS) {
1966 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001967#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001968 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001969#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001970 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001971 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001972 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1973 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001974#ifdef VK_USE_PLATFORM_ANDROID_KHR
1975 }
1976#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001977 } else {
1978 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1979 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001980 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1981 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1982 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001983 }
Dave Houlton130c0212018-01-29 13:39:56 -07001984
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001985 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1986 static_cast<uint64_t>(pCreateInfo->extent.height) *
1987 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1988 static_cast<uint64_t>(pCreateInfo->samples);
1989 uint64_t total_size =
1990 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07001991
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001992 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001993 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1994 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001995 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001996
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001997 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001998 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1999 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
2000 ", maximum resource size = 0x%" PRIxLEAST64 " ",
2001 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002002 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002003
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002004 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002005 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
2006 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
2007 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002008 }
2009
2010 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002011 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2012 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2013 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002014 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002015
2016 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2017 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2018 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2019 pCreateInfo->extent.width, format_limits.maxExtent.width);
2020 }
2021
2022 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2023 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2024 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2025 pCreateInfo->extent.height, format_limits.maxExtent.height);
2026 }
2027
2028 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2029 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2030 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2031 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2032 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002033 }
2034
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002035 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08002036 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
2037 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
2038 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
2039 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002040 skip |= LogError(device, error_vuid,
2041 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
2042 "YCbCr Conversion format, arrayLayers must be 1",
2043 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002044 }
2045
2046 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002047 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
2048 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
2049 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002050 }
2051
2052 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002053 skip |= LogError(
2054 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08002055 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2056 string_VkSampleCountFlagBits(pCreateInfo->samples));
2057 }
2058
2059 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002060 skip |= LogError(
2061 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002062 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2063 string_VkImageType(pCreateInfo->imageType));
2064 }
2065 }
2066
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002067 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002068 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002069 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002070 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002071 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2072 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2073 "format must be block, ETC or ASTC compressed, but is %s",
2074 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002075 }
2076 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002077 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2078 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2079 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002080 }
2081 }
2082 }
2083
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002084 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
ziga-lunarge2e283d2021-08-01 09:55:04 +02002085 const char *vuid = device_extensions.vk_khr_get_physical_device_properties2 ? "VUID-VkImageCreateInfo-sharingMode-01420"
2086 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002087 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02002088 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002089 }
2090
unknown2c877272019-07-11 12:56:50 -06002091 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2092 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2093 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002094 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2095 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2096 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002097 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002098
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002099 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002100 if (swapchain_create_info != nullptr) {
2101 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2102 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2103 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2104
2105 // Validate rest of Swapchain Image create check that require swapchain state
2106 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2107 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2108 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2109 skip |= LogError(
2110 device, vuid,
2111 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2112 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2113 }
2114 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2115 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2116 skip |= LogError(device, vuid,
2117 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2118 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2119 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002120 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002121 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2122 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2123 skip |= LogError(device, vuid,
2124 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2125 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002126 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002127 }
2128 }
2129 }
2130
sfricke-samsungedce77a2020-07-03 22:35:13 -07002131 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2132 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2133 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2134 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2135 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2136 }
2137 const VkImageCreateFlags invalid_flags =
2138 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2139 if ((pCreateInfo->flags & invalid_flags) != 0) {
2140 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2141 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2142 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2143 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2144 }
2145 }
2146
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002147 skip |= ValidateImageFormatFeatures(pCreateInfo);
2148
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002149 // Check compatibility with VK_KHR_portability_subset
2150 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2151 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2152 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2153 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2154 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2155 }
2156 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2157 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2158 skip |=
2159 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2160 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2161 }
2162 }
2163
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002164 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
2165 if (external_memory_create_info_nv != nullptr) {
2166 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2167 if (external_memory_create_info != nullptr) {
2168 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2169 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2170 "VkExternalMemoryImageCreateInfo chained structs.");
2171 }
2172 }
2173
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002174 if (device_group_create_info.physicalDeviceCount == 1) {
2175 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2176 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2177 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2178 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2179 }
2180 }
2181
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002182 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002183}
2184
John Zulauf7eeb6f72019-06-17 11:56:36 -06002185void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2186 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2187 if (VK_SUCCESS != result) return;
2188
2189 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002190 auto image_state = Get<IMAGE_STATE>(*pImage);
2191 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002192}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002193
Jeff Bolz5c801d12019-10-09 10:38:45 -05002194bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002195 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002196 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002197 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002198 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002199 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002200 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2201 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002202 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002203 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002204 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002205 }
2206 return skip;
2207}
2208
John Zulauf7eeb6f72019-06-17 11:56:36 -06002209void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2210 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002211 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002212
locke-lunargcba7d5f2019-12-30 16:59:11 -07002213 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002214
2215 // Clean up generic image state
2216 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002217}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002218
sfricke-samsungcd924d92020-05-20 23:51:17 -07002219bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2220 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002221 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002222 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002223 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002224
2225 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002226 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2227 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002228 }
2229
sfricke-samsungcd924d92020-05-20 23:51:17 -07002230 if (FormatIsDepthOrStencil(format)) {
2231 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2232 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2233 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2234 } else if (FormatIsCompressed(format)) {
2235 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2236 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2237 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002238 }
2239
2240 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002241 skip |=
2242 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2243 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2244 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002245 }
2246 return skip;
2247}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002248
John Zulauf07288512019-07-05 11:09:50 -06002249bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2250 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2251 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002252 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002253 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2254 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002255 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002256 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2257 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002258 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002259
2260 } else {
2261 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2262 if (!device_extensions.vk_khr_shared_presentable_image) {
2263 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002264 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002265 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2266 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002267 }
2268 } else {
2269 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2270 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002271 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002272 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002273 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2274 func_name, string_VkImageLayout(dest_image_layout));
2275 }
2276 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002277 }
2278
John Zulauff660ad62019-03-23 07:16:05 -06002279 // Cast to const to prevent creation at validate time.
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002280 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state->image());
John Zulauff660ad62019-03-23 07:16:05 -06002281 if (subresource_map) {
2282 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002283 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002284 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002285 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2286 // the next "constant value" range
2287 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002288 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002289 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2290 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2291 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2292 } else {
2293 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002294 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002295 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002296 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2297 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2298 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002299 }
John Zulauf5e617452019-11-19 14:44:16 -07002300 }
John Zulauff660ad62019-03-23 07:16:05 -06002301 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002302 }
2303
2304 return skip;
2305}
2306
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002307bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2308 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002309 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002310 bool skip = false;
2311 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002312 const auto *cb_node = GetCBState(commandBuffer);
2313 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002314 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002315 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002316 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002317 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002318 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2319 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002320 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002321 skip |=
2322 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2323 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2324 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002325 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002326 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002327 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002328 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002329 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002330 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002331 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2332 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2333 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2334 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2335 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2336 string_VkFormat(image_state->createInfo.format));
2337 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002338 }
2339 return skip;
2340}
2341
John Zulaufeabb4462019-07-05 14:13:03 -06002342void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2343 const VkClearColorValue *pColor, uint32_t rangeCount,
2344 const VkImageSubresourceRange *pRanges) {
2345 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2346
2347 auto cb_node = GetCBState(commandBuffer);
2348 auto image_state = GetImageState(image);
2349 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002350 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002351 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002352 }
2353 }
2354}
2355
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002356bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2357 const char *apiName) const {
2358 bool skip = false;
2359
2360 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2361 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2362 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2363 // Also VUID-VkClearDepthStencilValue-depth-00022
2364 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2365 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2366 "(=%f) is not within the [0.0, 1.0] range.",
2367 apiName, clearValue.depth);
2368 }
2369 }
2370
2371 return skip;
2372}
2373
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002374bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2375 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002376 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002377 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002378
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002379 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002380 const auto *cb_node = GetCBState(commandBuffer);
2381 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002382 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002383 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002384 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002385 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002386 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002387 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002388 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002389 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002390 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002391 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002392 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2393 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2394 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2395 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002396
2397 bool any_include_aspect_depth_bit = false;
2398 bool any_include_aspect_stencil_bit = false;
2399
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002400 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002401 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002402 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002403 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002404 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002405 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2406 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002407 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2408 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2409 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2410 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002411 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002412 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2413 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002414 if (FormatHasDepth(image_format) == false) {
2415 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2416 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2417 "doesn't have a depth component.",
2418 i, string_VkFormat(image_format));
2419 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002420 }
2421 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2422 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002423 if (FormatHasStencil(image_format) == false) {
2424 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2425 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2426 "%s doesn't have a stencil component.",
2427 i, string_VkFormat(image_format));
2428 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002429 }
2430 }
2431 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002432 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002433 if (image_stencil_struct != nullptr) {
2434 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2435 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002436 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2437 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2438 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2439 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002440 }
2441 } else {
2442 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002443 skip |= LogError(
2444 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002445 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2446 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2447 "in VkImageCreateInfo::usage used to create image");
2448 }
2449 }
2450 }
2451 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002452 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2453 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2454 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002455 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002456 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002457 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2458 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002459 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002460 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002461 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002462 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2463 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2464 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2465 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002466 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002467 }
2468 return skip;
2469}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002470
John Zulaufeabb4462019-07-05 14:13:03 -06002471void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2472 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2473 const VkImageSubresourceRange *pRanges) {
2474 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2475 auto cb_node = GetCBState(commandBuffer);
2476 auto image_state = GetImageState(image);
2477 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002478 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002479 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002480 }
2481 }
2482}
2483
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002484// Returns true if [x, xoffset] and [y, yoffset] overlap
2485static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2486 bool result = false;
2487 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2488 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2489
2490 if (intersection_max > intersection_min) {
2491 result = true;
2492 }
2493 return result;
2494}
2495
Jeff Leger178b1e52020-10-05 12:22:23 -04002496// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002497// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002498template <typename RegionType>
2499static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002500 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002501
Dave Houltonc991cc92018-03-06 11:08:51 -07002502 // Separate planes within a multiplane image cannot intersect
2503 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002504 return result;
2505 }
2506
Dave Houltonc991cc92018-03-06 11:08:51 -07002507 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2508 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2509 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002510 result = true;
2511 switch (type) {
2512 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002513 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002514 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002515 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002516 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002517 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002518 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002519 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002520 break;
2521 default:
2522 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2523 assert(false);
2524 }
2525 }
2526 return result;
2527}
2528
Dave Houltonfc1a4052017-04-27 14:32:45 -06002529// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002530static const uint32_t kXBit = 1;
2531static const uint32_t kYBit = 2;
2532static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002533static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002534 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002535 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002536 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2537 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002538 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002539 }
2540 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2541 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002542 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002543 }
2544 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2545 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002546 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002547 }
2548 return result;
2549}
2550
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002551// Test if two VkExtent3D structs are equivalent
2552static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2553 bool result = true;
2554 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2555 (extent->depth != other_extent->depth)) {
2556 result = false;
2557 }
2558 return result;
2559}
2560
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002561// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002562static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002563 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2564}
2565
2566// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002567VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002568 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2569 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002570 auto pool = cb_node->command_pool.get();
2571 if (pool) {
2572 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002573 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002574 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002575 granularity.width *= block_size.width;
2576 granularity.height *= block_size.height;
2577 }
2578 }
2579 return granularity;
2580}
2581
2582// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2583static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2584 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002585 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2586 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 valid = false;
2588 }
2589 return valid;
2590}
2591
2592// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002593bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002594 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002595 bool skip = false;
2596 VkExtent3D offset_extent = {};
2597 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2598 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2599 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002600 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002601 // 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 -07002602 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002603 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002604 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) when the command buffer's queue family "
2605 "image transfer granularity is (w=0, h=0, d=0).",
2606 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002607 }
2608 } else {
2609 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2610 // integer multiples of the image transfer granularity.
2611 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002612 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002613 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2614 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2615 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2616 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002617 }
2618 }
2619 return skip;
2620}
2621
2622// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002623bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002624 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002625 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002627 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002628 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2629 // subresource extent.
2630 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002631 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002632 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2633 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2634 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2635 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636 }
2637 } else {
2638 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2639 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2640 // subresource extent dimensions.
2641 VkExtent3D offset_extent_sum = {};
2642 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2643 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2644 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002645 bool x_ok = true;
2646 bool y_ok = true;
2647 bool z_ok = true;
2648 switch (image_type) {
2649 case VK_IMAGE_TYPE_3D:
2650 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2651 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002652 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002653 case VK_IMAGE_TYPE_2D:
2654 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2655 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002656 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002657 case VK_IMAGE_TYPE_1D:
2658 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2659 (subresource_extent->width == offset_extent_sum.width));
2660 break;
2661 default:
2662 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2663 assert(false);
2664 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002665 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002666 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002667 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002668 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2669 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2670 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2671 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2672 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2673 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002674 }
2675 }
2676 return skip;
2677}
2678
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002679bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002680 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002681 bool skip = false;
2682 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002683 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2684 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002685 }
2686 return skip;
2687}
2688
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002689bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002690 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002691 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002692 bool skip = false;
2693 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2694 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002695 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002696 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2697 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002698 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002699 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002700 }
2701 return skip;
2702}
2703
Jeff Leger178b1e52020-10-05 12:22:23 -04002704// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2705template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002706bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002707 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002708 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002709 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002710 VkExtent3D granularity = GetScaledItg(cb_node, img);
2711 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002712 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002713 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002714 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002715 return skip;
2716}
2717
Jeff Leger178b1e52020-10-05 12:22:23 -04002718// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2719template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002720bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002721 const IMAGE_STATE *dst_img, const RegionType *region,
2722 const uint32_t i, const char *function,
2723 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002724 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002725 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2726 const char *vuid;
2727
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002728 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002729 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002730 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2731 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002732 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002733 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002735 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002736 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002737
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002738 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002739 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002740 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2741 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002742 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002743 const VkExtent3D dest_effective_extent =
2744 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002745 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002746 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002747 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002748 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002749 return skip;
2750}
2751
Jeff Leger178b1e52020-10-05 12:22:23 -04002752// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2753template <typename ImageCopyRegionType>
2754bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2755 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2756 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002757 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002758 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2759 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2760 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002761
2762 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002763 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002764
2765 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002766 const VkExtent3D src_copy_extent = region.extent;
2767 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002768 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2769
Dave Houlton6f9059e2017-05-02 17:15:13 -06002770 bool slice_override = false;
2771 uint32_t depth_slices = 0;
2772
2773 // Special case for copying between a 1D/2D array and a 3D image
2774 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2775 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002776 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002777 slice_override = (depth_slices != 1);
2778 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002779 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002780 slice_override = (depth_slices != 1);
2781 }
2782
2783 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002784 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002785 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002786 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002787 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002788 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2789 "be 0 and 1, respectively.",
2790 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002791 }
2792 }
2793
Dave Houlton533be9f2018-03-26 17:08:30 -06002794 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002795 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002796 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002798 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002799 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002800 }
2801
Dave Houlton533be9f2018-03-26 17:08:30 -06002802 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002804 skip |= LogError(src_state->image(), vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002805 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002806 }
2807
Dave Houltonc991cc92018-03-06 11:08:51 -07002808 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002809 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002810 if (FormatIsCompressed(src_state->createInfo.format) ||
2811 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002812 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002813 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002814 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2815 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2816 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002817 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002818 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002819 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002820 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002822 }
2823
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002824 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002825 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2826 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002827 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002828 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002829 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2830 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2831 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002832 }
2833
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002834 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002835 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2836 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002837 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002838 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002839 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2840 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2841 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002842 }
2843
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002844 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002845 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2846 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002847 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002848 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002849 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2850 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2851 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002852 }
2853 } // Compressed
2854
2855 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002856 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002857 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002858 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002859 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002861 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002863 }
2864 }
2865
Dave Houlton533be9f2018-03-26 17:08:30 -06002866 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002867 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002868 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002869 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2870 "and 1, respectively.",
2871 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002872 }
2873
Dave Houlton533be9f2018-03-26 17:08:30 -06002874 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002875 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002876 skip |= LogError(dst_state->image(), vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002877 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002878 }
2879
sfricke-samsung30b094c2020-05-30 11:42:11 -07002880 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002881 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002882 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2883 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002884 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002885 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002886 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2887 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2888 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002889 }
2890 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002891 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002892 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002894 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002895 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2896 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2897 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002898 }
2899 }
2900 } else { // Pre maint 1
2901 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002902 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002903 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002904 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002905 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002906 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2907 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002908 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002909 }
Dave Houltonee281a52017-12-08 13:51:02 -07002910 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002911 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002912 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002913 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002914 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2915 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002916 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002917 }
2918 }
2919 }
2920
Dave Houltonc991cc92018-03-06 11:08:51 -07002921 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2922 if (FormatIsCompressed(dst_state->createInfo.format) ||
2923 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002924 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002925
2926 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002927 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2928 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2929 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002930 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002931 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002932 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002933 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002934 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002935 }
2936
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002937 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002938 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2939 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002940 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002941 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002942 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2943 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2944 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002945 }
2946
Dave Houltonee281a52017-12-08 13:51:02 -07002947 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2948 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2949 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002950 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002951 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002952 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002953 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2954 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002955 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002956 }
2957
Dave Houltonee281a52017-12-08 13:51:02 -07002958 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2959 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2960 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002961 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002962 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002963 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2964 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2965 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002966 }
2967 } // Compressed
2968 }
2969 return skip;
2970}
2971
Jeff Leger178b1e52020-10-05 12:22:23 -04002972template <typename RegionType>
2973bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2974 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2975 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002976 const auto *cb_node = GetCBState(commandBuffer);
2977 const auto *src_image_state = GetImageState(srcImage);
2978 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002979 const VkFormat src_format = src_image_state->createInfo.format;
2980 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002981 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002982 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002983
Jeff Leger178b1e52020-10-05 12:22:23 -04002984 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2985 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2986 const char *vuid;
2987
2988 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002989
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002990 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002991
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002992 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002993 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002994
2995 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2996 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002997 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002998
Dave Houlton6f9059e2017-05-02 17:15:13 -06002999 bool slice_override = false;
3000 uint32_t depth_slices = 0;
3001
3002 // Special case for copying between a 1D/2D array and a 3D image
3003 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3004 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3005 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003006 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003007 slice_override = (depth_slices != 1);
3008 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3009 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003010 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003011 slice_override = (depth_slices != 1);
3012 }
3013
Jeff Leger178b1e52020-10-05 12:22:23 -04003014 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
3015 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
3016 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3017 skip |=
3018 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3019 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3020 skip |=
3021 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3022 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003023 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003024 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3025 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003026 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003027 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003028
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003029 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003030 // No chance of mismatch if we're overriding depth slice count
3031 if (!slice_override) {
3032 // The number of depth slices in srcSubresource and dstSubresource must match
3033 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3034 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003035 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3036 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003037 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003038 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3039 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003040 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003041 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
3042 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003043 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3044 "do not match.",
3045 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003046 }
3047 }
3048 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003049 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003050 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003051 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003052 skip |=
3053 LogError(command_buffer, vuid,
3054 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3055 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003056 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003057 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003058
Dave Houltonc991cc92018-03-06 11:08:51 -07003059 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003060 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003061 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3062 // If neither image is multi-plane the aspectMask member of src and dst must match
3063 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
3064 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
3065 skip |= LogError(command_buffer, vuid,
3066 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3067 "source (0x%x) destination (0x%x).",
3068 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3069 }
3070 } else {
3071 // Source image multiplane checks
3072 uint32_t planes = FormatPlaneCount(src_format);
3073 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3074 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3075 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
3076 skip |= LogError(command_buffer, vuid,
3077 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3078 i, aspect);
3079 }
3080 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3081 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3082 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3083 skip |= LogError(command_buffer, vuid,
3084 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3085 i, aspect);
3086 }
3087 // Single-plane to multi-plane
3088 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3089 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3090 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3091 skip |= LogError(command_buffer, vuid,
3092 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3093 func_name, i, aspect);
3094 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003095
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003096 // Dest image multiplane checks
3097 planes = FormatPlaneCount(dst_format);
3098 aspect = region.dstSubresource.aspectMask;
3099 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3100 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3101 skip |= LogError(command_buffer, vuid,
3102 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3103 i, aspect);
3104 }
3105 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3106 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3107 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3108 skip |= LogError(command_buffer, vuid,
3109 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3110 i, aspect);
3111 }
3112 // Multi-plane to single-plane
3113 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3114 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3115 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3116 skip |= LogError(command_buffer, vuid,
3117 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3118 func_name, i, aspect);
3119 }
3120 }
3121 } else {
3122 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003123 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3124 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003125 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003126 skip |= LogError(
3127 command_buffer, vuid,
3128 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3129 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003130 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003131 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003132
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003133 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003134 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003135 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003136 skip |=
3137 LogError(command_buffer, vuid,
3138 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3139 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003140 }
3141
3142 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003143 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003144 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003145 skip |= LogError(
3146 command_buffer, vuid,
3147 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3148 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003149 }
3150
Dave Houltonfc1a4052017-04-27 14:32:45 -06003151 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003152 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003153 if (slice_override) src_copy_extent.depth = depth_slices;
3154 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003155 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003156 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3157 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003158 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003159 "width [%1d].",
3160 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003161 }
3162
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003163 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003164 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3165 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003166 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003167 "height [%1d].",
3168 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003169 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003170 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003171 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3172 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003173 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003174 "depth [%1d].",
3175 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003176 }
3177
Dave Houltonee281a52017-12-08 13:51:02 -07003178 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003179 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003180 if (slice_override) dst_copy_extent.depth = depth_slices;
3181
3182 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003183 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3185 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003186 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003187 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003188 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003189 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003190 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003191 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3192 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003193 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003194 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003195 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003196 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003197 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003198 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3199 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003200 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003201 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003202 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003203 }
3204
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003205 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3206 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003207 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003208 for (uint32_t j = 0; j < regionCount; j++) {
3209 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003210 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003211 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003212 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003213 }
3214 }
3215 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003216
3217 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3218 if (device_extensions.vk_khr_maintenance1) {
3219 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3220 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3221 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003222 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3223 skip |= LogError(command_buffer, vuid,
3224 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3225 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003226 }
3227 } else {
3228 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3229 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3230 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003231 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3232 skip |= LogError(command_buffer, vuid,
3233 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3234 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003235 }
3236 }
3237
3238 // Check if 2D with 3D and depth not equal to 2D layerCount
3239 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3240 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3241 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003242 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3243 skip |= LogError(command_buffer, vuid,
3244 "%s: pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
sfricke-samsung48172ca2020-02-13 23:38:11 -08003245 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003246 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003247 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3248 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3249 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003250 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3251 skip |= LogError(command_buffer, vuid,
3252 "%s: pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
sfricke-samsung48172ca2020-02-13 23:38:11 -08003253 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003254 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003255 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003256
3257 // Check for multi-plane format compatiblity
3258 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3259 size_t src_format_size = 0;
3260 size_t dst_format_size = 0;
3261 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003262 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3263 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003264 } else {
3265 src_format_size = FormatElementSize(src_format);
3266 }
3267 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003268 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3269 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003270 } else {
3271 dst_format_size = FormatElementSize(dst_format);
3272 }
3273 // If size is still zero, then format is invalid and will be caught in another VU
3274 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003275 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3276 skip |= LogError(command_buffer, vuid,
3277 "%s: pRegions[%u] called with non-compatible image formats. "
3278 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3279 func_name, i, string_VkFormat(src_format),
3280 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3281 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003282 }
3283 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003284 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003285
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003286 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3287 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3288 // because because both texels are 4 bytes in size.
3289 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003290 const char *compatible_vuid =
3291 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3292 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3293 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003294 // Depth/stencil formats must match exactly.
3295 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3296 if (src_format != dst_format) {
3297 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003298 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003299 string_VkFormat(src_format), string_VkFormat(dst_format));
3300 }
3301 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003302 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003303 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003304 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003305 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003306 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003307 FormatElementSize(dst_format));
3308 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003309 }
3310 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003311
Dave Houlton33c22b72017-02-28 13:16:02 -07003312 // Source and dest image sample counts must match
3313 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003314 std::stringstream ss;
3315 ss << func_name << " called on image pair with non-identical sample counts.";
3316 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003317 skip |=
3318 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3319 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3320 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003321 }
3322
Tony-LunarG5a066372021-01-21 10:31:34 -07003323 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3324 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3325 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003326 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003327 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3328 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3329 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3330 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003331 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003332 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3333 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3334 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3335 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3336 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3337 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3338 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3339 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3340 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3341 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3342 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3343 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003344
3345 // Validation for VK_EXT_fragment_density_map
3346 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003347 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3348 skip |=
3349 LogError(command_buffer, vuid,
3350 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT", func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003351 }
3352 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003353 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3354 skip |=
3355 LogError(command_buffer, vuid,
3356 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT", func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003357 }
3358
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003359 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003360 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3361 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3362 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3363 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003364 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003365 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003366 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003367
3368 const char *invalid_src_layout_vuid =
3369 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3370 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3371 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3372 const char *invalid_dst_layout_vuid =
3373 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3374 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3375 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3376
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003377 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003378 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003379 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003380 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3381 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003382 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003383 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003384 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003385 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003386 }
3387
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003388 return skip;
3389}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003390
Jeff Leger178b1e52020-10-05 12:22:23 -04003391bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3392 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3393 const VkImageCopy *pRegions) const {
3394 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3395 COPY_COMMAND_VERSION_1);
3396}
3397
3398bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3399 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3400 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3401 COPY_COMMAND_VERSION_2);
3402}
3403
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003404void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3405 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3406 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003407 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3408 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003409 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003410 auto src_image_state = GetImageState(srcImage);
3411 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003412
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003413 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003414 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003415 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3416 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003417 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003418}
3419
Jeff Leger178b1e52020-10-05 12:22:23 -04003420void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3421 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3422 auto cb_node = GetCBState(commandBuffer);
3423 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3424 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3425
3426 // Make sure that all image slices are updated to correct layout
3427 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3428 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3429 pCopyImageInfo->srcImageLayout);
3430 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3431 pCopyImageInfo->dstImageLayout);
3432 }
3433}
3434
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003435// Returns true if sub_rect is entirely contained within rect
3436static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3437 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003438 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height)) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003439 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003440 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003441 return true;
3442}
3443
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003444bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003445 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003446 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3447 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003448 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003449 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3450 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003451 if (primary_cb_state) {
3452 image_view_state = primary_cb_state->GetActiveAttachmentImageViewState(fb_attachment);
3453 } else {
3454 image_view_state = GetCBState(command_buffer)->GetActiveAttachmentImageViewState(fb_attachment);
3455 }
John Zulauff2582972019-02-09 14:53:30 -07003456 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003457
3458 for (uint32_t j = 0; j < rect_count; j++) {
3459 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003460 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3461 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3462 "the current render pass instance.",
3463 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003464 }
3465
3466 if (image_view_state) {
3467 // The layers specified by a given element of pRects must be contained within every attachment that
3468 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003469 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003470 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3471 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003472 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3473 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3474 "of pAttachment[%d].",
3475 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003476 }
3477 }
3478 }
3479 return skip;
3480}
3481
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003482bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3483 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003484 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003485 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003486 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003487 if (!cb_node) return skip;
3488
Petr Kraus2dffb382019-08-10 02:52:12 +02003489 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003490
3491 // Validate that attachment is in reference list of active subpass
3492 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003493 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003494 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003495 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003496 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003497 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003498
John Zulauf3a548ef2019-02-01 16:14:07 -07003499 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3500 auto clear_desc = &pAttachments[attachment_index];
3501 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003502 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003503
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003504 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3505 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3506 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3507 attachment_index);
3508 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3509 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3510 skip |=
3511 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3512 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3513 attachment_index);
3514 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003515 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3516 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3517 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3518 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003519 skip |= LogError(
3520 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3521 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3522 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3523 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003524 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003525 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003526
John Zulauff2582972019-02-09 14:53:30 -07003527 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3528 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003529 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003530 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3531 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3532 " subpass %u. colorAttachmentCount=%u",
3533 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003534 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003535 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003536 }
John Zulauff2582972019-02-09 14:53:30 -07003537 fb_attachment = color_attachment;
3538
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003539 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3540 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3541 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3542 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3543 "of a color attachment.",
3544 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003545 }
3546 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003547 bool subpass_depth = false;
3548 bool subpass_stencil = false;
3549 if (subpass_desc->pDepthStencilAttachment &&
3550 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3551 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3552 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3553 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3554 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003555 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003556 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3557 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003558 skip |= LogError(
3559 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3560 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003561 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003562 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003563 }
3564 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003565 skip |= LogError(
3566 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3567 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003568 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003569 attachment_index);
3570 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003571 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003572 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003573 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003574 if (subpass_depth) {
3575 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3576 "vkCmdClearAttachments()");
3577 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003578 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003579 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003580 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3581 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003582 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003583
3584 // Once the framebuffer attachment is found, can get the image view state
3585 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3586 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3587 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003588 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003589 if (image_view_state != nullptr) {
3590 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3591 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3592 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3593 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3594 }
3595 }
John Zulauf441558b2019-08-12 11:47:39 -06003596 }
3597 }
3598 return skip;
3599}
3600
3601void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3602 const VkClearAttachment *pAttachments, uint32_t rectCount,
3603 const VkClearRect *pRects) {
3604 auto *cb_node = GetCBState(commandBuffer);
3605 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003606 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3607 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003608 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3609 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3610 const auto clear_desc = &pAttachments[attachment_index];
3611 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3612 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3613 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3614 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3615 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3616 subpass_desc->pDepthStencilAttachment) {
3617 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3618 }
3619 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003620 if (!clear_rect_copy) {
3621 // We need a copy of the clear rectangles that will persist until the last lambda executes
3622 // but we want to create it as lazily as possible
3623 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003624 }
John Zulauf441558b2019-08-12 11:47:39 -06003625 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3626 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003627 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003628 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003629 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003630 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3631 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003632 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003633 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003634 return skip;
3635 };
3636 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003637 }
3638 }
3639 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003640}
3641
Jeff Leger178b1e52020-10-05 12:22:23 -04003642template <typename RegionType>
3643bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3644 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3645 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003646 const auto *cb_node = GetCBState(commandBuffer);
3647 const auto *src_image_state = GetImageState(srcImage);
3648 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003649 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3650 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3651 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3652 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003653
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003654 bool skip = false;
3655 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003656 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3657 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3658 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3659 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003660 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003661 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3662 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3663 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3664 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3665 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3666 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3667 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3668 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003669
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003670 // Validation for VK_EXT_fragment_density_map
3671 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003672 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003673 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003674 "%s: srcImage must not have been created with flags containing "
3675 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3676 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003677 }
3678 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003679 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003680 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003681 "%s: dstImage must not have been created with flags containing "
3682 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3683 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003684 }
3685
Cort Stratton7df30962018-05-17 19:45:57 -07003686 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003687 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003688 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3689 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003690 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003691 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3692 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3693 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003694 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003695 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3696 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3697 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3698 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3699 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3700 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003701 // For each region, the number of layers in the image subresource should not be zero
3702 // For each region, src and dest image aspect must be color only
3703 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003704 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003705 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3706 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003707 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3708 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3709 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003710 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003711 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3712 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003713 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003714 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3715 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3716 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3717 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3718 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3719 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003720 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003721 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3722 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003723 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003724 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003725
3726 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003727 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003728 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3729 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003730 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003731 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003732 }
Cort Stratton7df30962018-05-17 19:45:57 -07003733 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003734 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3735 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003736 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003737 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003738 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3739 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003740 }
3741
3742 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3743 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3744
3745 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003746 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003747 LogObjectList objlist(cb_node->commandBuffer());
3748 objlist.add(src_image_state->image());
3749 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003750 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3751 skip |= LogError(objlist, vuid,
3752 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003753 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003754 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003755 }
3756 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003757 LogObjectList objlist(cb_node->commandBuffer());
3758 objlist.add(src_image_state->image());
3759 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003760 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3761 skip |= LogError(objlist, vuid,
3762 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003763 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003764 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003765 }
3766 }
3767
3768 if (VK_IMAGE_TYPE_1D == src_image_type) {
3769 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003770 LogObjectList objlist(cb_node->commandBuffer());
3771 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3773 skip |= LogError(objlist, vuid,
3774 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003775 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003776 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003777 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003778 }
3779 }
3780 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3781 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003782 LogObjectList objlist(cb_node->commandBuffer());
3783 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003784 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3785 skip |= LogError(objlist, vuid,
3786 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003787 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003788 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003789 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003790 }
3791 }
3792
3793 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3794 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003795 LogObjectList objlist(cb_node->commandBuffer());
3796 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003797 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3798 skip |= LogError(objlist, vuid,
3799 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003800 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003801 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003802 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003803 }
3804 }
3805 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3806 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003807 LogObjectList objlist(cb_node->commandBuffer());
3808 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003809 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3810 skip |= LogError(objlist, vuid,
3811 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003812 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003813 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003814 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003815 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003816 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003817
3818 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003819 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003820 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3821 // developer
3822 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3823 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003824 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003825 LogObjectList objlist(cb_node->commandBuffer());
3826 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003827 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3828 skip |= LogError(objlist, vuid,
3829 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003830 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003831 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003832 region.extent.width, subresource_extent.width);
3833 }
3834
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003835 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003836 LogObjectList objlist(cb_node->commandBuffer());
3837 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003838 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3839 skip |= LogError(objlist, vuid,
3840 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003841 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003842 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003843 region.extent.height, subresource_extent.height);
3844 }
3845
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003846 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003847 LogObjectList objlist(cb_node->commandBuffer());
3848 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003849 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3850 skip |= LogError(objlist, vuid,
3851 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003852 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003853 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003854 region.extent.depth, subresource_extent.depth);
3855 }
3856 }
3857
3858 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003859 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003860 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3861 // developer
3862 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3863 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003864 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003865 LogObjectList objlist(cb_node->commandBuffer());
3866 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003867 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3868 skip |= LogError(objlist, vuid,
3869 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003870 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003871 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003872 region.extent.width, subresource_extent.width);
3873 }
3874
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003875 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003876 LogObjectList objlist(cb_node->commandBuffer());
3877 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003878 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3879 skip |= LogError(objlist, vuid,
3880 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003881 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003882 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003883 region.extent.height, subresource_extent.height);
3884 }
3885
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003886 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003887 LogObjectList objlist(cb_node->commandBuffer());
3888 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003889 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3890 skip |= LogError(objlist, vuid,
3891 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003892 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003893 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003894 region.extent.depth, subresource_extent.depth);
3895 }
3896 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003897 }
3898
3899 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003900 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003901 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003902 func_name, string_VkFormat(src_image_state->createInfo.format),
3903 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003904 }
3905 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003906 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003907 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003908 string_VkImageType(src_image_state->createInfo.imageType),
3909 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003910 }
3911 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003913 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: srcImage sample count is VK_SAMPLE_COUNT_1_BIT.", func_name);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003914 }
3915 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003916 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003917 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003919 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003920 } else {
3921 assert(0);
3922 }
3923 return skip;
3924}
3925
Jeff Leger178b1e52020-10-05 12:22:23 -04003926bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3927 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3928 const VkImageResolve *pRegions) const {
3929 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3930 COPY_COMMAND_VERSION_1);
3931}
3932
3933bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3934 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3935 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3936 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3937 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3938}
3939
3940template <typename RegionType>
3941bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3942 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3943 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003944 const auto *cb_node = GetCBState(commandBuffer);
3945 const auto *src_image_state = GetImageState(srcImage);
3946 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003947
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3949 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3950 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3951
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003952 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003953 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003954 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003955 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003956 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003957 const char *vuid;
3958 const char *location;
3959 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3960 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3961 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3962 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3963 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3964 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3965 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3966 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3967 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3968 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3969 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3970 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3971 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3972 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3973 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3974 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04003975 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003976 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3977 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3978 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3979 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3980 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3981 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3982 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3983 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3984 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3985 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003986
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003987 // Validation for VK_EXT_fragment_density_map
3988 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003989 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003990 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003991 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3992 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003993 }
3994 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003995 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003996 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003997 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3998 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003999 }
4000
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004001 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004002
Dave Houlton33c2d252017-06-09 17:08:32 -06004003 VkFormat src_format = src_image_state->createInfo.format;
4004 VkFormat dst_format = dst_image_state->createInfo.format;
4005 VkImageType src_type = src_image_state->createInfo.imageType;
4006 VkImageType dst_type = dst_image_state->createInfo.imageType;
4007
Cort Stratton186b1a22018-05-01 20:18:06 -04004008 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004009 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4010 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
4011 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004012 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004013 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004014 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04004015 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004016 }
4017
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004018 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
4020 skip |= LogError(device, vuid,
4021 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004022 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004023 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004024 }
4025
4026 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004027 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
4028 skip |= LogError(device, vuid,
4029 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004030 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004031 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004032 }
4033
Dave Houlton33c2d252017-06-09 17:08:32 -06004034 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004035 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004036 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004037 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004038 }
4039
Dave Houlton33c2d252017-06-09 17:08:32 -06004040 // Validate consistency for unsigned formats
4041 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
4042 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004043 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004044 << "the other one must also have unsigned integer format. "
4045 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004046 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004047 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004048 }
4049
4050 // Validate consistency for signed formats
4051 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
4052 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004054 << "the other one must also have signed integer format. "
4055 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004056 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004057 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004058 }
4059
4060 // Validate filter for Depth/Stencil formats
4061 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4062 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004063 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004064 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04004065 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004066 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004067 }
4068
4069 // Validate aspect bits and formats for depth/stencil images
4070 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4071 if (src_format != dst_format) {
4072 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004073 ss << func_name << ": If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06004074 << "stencil, the other one must have exactly the same format. "
4075 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4076 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004077 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004078 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004079 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004080 } // Depth or Stencil
4081
4082 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004083 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004084 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4085 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4086 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4087 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4088 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4089 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004090 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004091 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4092 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4093 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4094 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4095 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4096 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004097 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004098 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004099 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004100 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004101 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004102 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4103 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004104 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004105 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4106 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4107 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4108 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4109 skip |=
4110 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4111 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4112 skip |=
4113 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4114 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004115 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004116 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4117 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004118 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004119 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004120 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004121 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4122 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004123 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004124 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004125 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004126 }
Dave Houlton48989f32017-05-26 15:01:46 -06004127 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4128 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004129 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004130 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004131 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004132 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004133
4134 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004135 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004136 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4137 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004138 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004139 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004140 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004141
Dave Houlton48989f32017-05-26 15:01:46 -06004142 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004143 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4144 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004145 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004146 }
Dave Houlton48989f32017-05-26 15:01:46 -06004147
Dave Houlton33c2d252017-06-09 17:08:32 -06004148 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004149 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004150 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004151 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004152 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004153 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004154 }
4155
4156 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004157 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004158 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004159 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4160 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004161 }
4162
Dave Houlton48989f32017-05-26 15:01:46 -06004163 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004164 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004165 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004166 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004167 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004168 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004169 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4170 "of (%1d, %1d). These must be (0, 1).",
4171 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004172 }
4173 }
4174
Dave Houlton33c2d252017-06-09 17:08:32 -06004175 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004176 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004177 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004178 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004179 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4180 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4181 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004182 }
4183 }
4184
Dave Houlton33c2d252017-06-09 17:08:32 -06004185 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004186 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4187 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004188 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004189 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004190 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004191 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4192 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004193 }
4194 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4195 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004196 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004197 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004198 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004199 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4200 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004201 }
4202 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4203 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004204 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004205 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004206 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004207 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4208 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004209 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004210 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004211 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004212 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004213 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004214 }
Dave Houlton48989f32017-05-26 15:01:46 -06004215
4216 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004217 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004218 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004219 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004220 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004221 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004222 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4223 "(%1d, %1d). These must be (0, 1).",
4224 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004225 }
4226 }
4227
Dave Houlton33c2d252017-06-09 17:08:32 -06004228 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004229 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004230 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004231 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004232 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004233 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004234 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004235 }
4236 }
4237
Dave Houlton33c2d252017-06-09 17:08:32 -06004238 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004239 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4240 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004241 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004242 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004243 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004244 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4245 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004246 }
4247 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4248 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004249 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004250 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004251 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004252 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4253 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004254 }
4255 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4256 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004257 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004258 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004259 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004260 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4261 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004262 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004263 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004264 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004265 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004266 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004267 }
4268
Dave Houlton33c2d252017-06-09 17:08:32 -06004269 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4270 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4271 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004272 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004273 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004274 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4275 "layerCount other than 1.",
4276 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004277 }
4278 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004279 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004280 } else {
4281 assert(0);
4282 }
4283 return skip;
4284}
4285
Jeff Leger178b1e52020-10-05 12:22:23 -04004286bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4287 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4288 const VkImageBlit *pRegions, VkFilter filter) const {
4289 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4290 COPY_COMMAND_VERSION_1);
4291}
4292
4293bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4294 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4295 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4296 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4297}
4298
4299template <typename RegionType>
4300void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4301 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4302 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004303 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004304 auto src_image_state = GetImageState(srcImage);
4305 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004306
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004307 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004308 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004309 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4310 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004311 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004312}
4313
Jeff Leger178b1e52020-10-05 12:22:23 -04004314void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4315 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4316 const VkImageBlit *pRegions, VkFilter filter) {
4317 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4318 pRegions, filter);
4319 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4320}
4321
4322void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4323 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4324 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4325 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4326 pBlitImageInfo->filter);
4327}
4328
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004329GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004330 // This approach allows for a single hash lookup or/create new
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004331 auto &layout_map = map[image_state.image()];
John Zulauf17708d02021-02-22 11:20:58 -07004332 if (!layout_map) {
4333 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004334 }
John Zulauf17708d02021-02-22 11:20:58 -07004335 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004336}
4337
4338const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4339 auto it = map.find(image);
4340 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004341 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004342 }
4343 return nullptr;
4344}
4345
Jeremy Gebben53631302021-04-13 16:46:37 -06004346// Helper to update the Global or Overlay layout map
4347struct GlobalLayoutUpdater {
4348 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4349 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4350 dst = src.current_layout;
4351 return true;
4352 }
4353 return false;
4354 }
4355
4356 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4357 layer_data::optional<VkImageLayout> result;
4358 if (src.current_layout != image_layout_map::kInvalidLayout) {
4359 result.emplace(src.current_layout);
4360 }
4361 return result;
4362 }
4363};
4364
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004365// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004366bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
4367 const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004368 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004369 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004370 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004371 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004372 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004373 for (const auto &layout_map_entry : pCB->image_layout_map) {
4374 const auto image = layout_map_entry.first;
4375 const auto *image_state = GetImageState(image);
4376 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004377 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004378 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004379 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004380 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004381
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004382 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004383 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4384 if (global_map == nullptr) {
4385 global_map = &empty_map;
4386 }
4387
4388 // Note: don't know if it would matter
4389 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4390
Jeremy Gebben53631302021-04-13 16:46:37 -06004391 auto pos = layout_map.begin();
4392 const auto end = layout_map.end();
4393 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4394 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004395 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004396 VkImageLayout initial_layout = pos->second.initial_layout;
4397 assert(initial_layout != image_layout_map::kInvalidLayout);
4398 if (initial_layout == image_layout_map::kInvalidLayout) {
4399 continue;
4400 }
4401
John Zulauf2076e812020-01-08 14:55:54 -07004402 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004403
John Zulauf2076e812020-01-08 14:55:54 -07004404 if (current_layout->range.empty()) break; // When we are past the end of data in overlay and global... stop looking
locke-lunargf155ccf2020-02-18 11:34:15 -07004405 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004406 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004407 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004408 image_layout = current_layout->pos_B->lower_bound->second;
4409 }
4410 const auto intersected_range = pos->first & current_layout->range;
4411 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4412 // TODO: Set memory invalid which is in mem_tracker currently
4413 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004414 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4415 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004416 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004417 // We can report all the errors for the intersected range directly
4418 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004419 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004420 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004421 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004422 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004423 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004424 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
John Zulauf2076e812020-01-08 14:55:54 -07004425 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004426 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004427 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004428 }
4429 }
John Zulauf2076e812020-01-08 14:55:54 -07004430 if (pos->first.includes(intersected_range.end)) {
4431 current_layout.seek(intersected_range.end);
4432 } else {
4433 ++pos;
4434 if (pos != end) {
4435 current_layout.seek(pos->first.begin);
4436 }
4437 }
John Zulauff660ad62019-03-23 07:16:05 -06004438 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004439 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004440 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004441 }
John Zulauff660ad62019-03-23 07:16:05 -06004442
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004443 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004444}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004445
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004446void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004447 for (const auto &layout_map_entry : pCB->image_layout_map) {
4448 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004449 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004450 const auto *image_state = GetImageState(image);
4451 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004452 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004453 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004454 }
4455}
4456
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004457// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004458// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4459// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004460bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4461 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004462 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004463 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004464 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4465
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004466 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004467 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4468 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004469 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004470 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4471 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4472 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004473 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004474 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004475 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004476 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4477 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4478 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004479 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004480 string_VkImageLayout(first_layout));
4481 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4482 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004483 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004484 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004485 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004486 }
4487 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004488
4489 // Same as above for loadOp, but for stencilLoadOp
4490 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4491 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4492 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4493 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4494 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004495 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004496 string_VkImageLayout(first_layout));
4497 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4498 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4499 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004500 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004501 string_VkImageLayout(first_layout));
4502 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4503 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4504 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004505 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004506 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004507 }
4508 }
4509
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004510 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004511}
4512
Mark Lobodzinski96210742017-02-09 10:33:46 -07004513// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4514// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004515template <typename T1>
4516bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4517 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4518 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004519 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004520 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004521 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004522 if (strict) {
4523 correct_usage = ((actual & desired) == desired);
4524 } else {
4525 correct_usage = ((actual & desired) != 0);
4526 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004527
Mark Lobodzinski96210742017-02-09 10:33:46 -07004528 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004529 // All callers should have a valid VUID
4530 assert(msgCode != kVUIDUndefined);
4531 skip =
4532 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4533 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004534 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004535 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004536}
4537
4538// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4539// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004540bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004541 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004542 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004543 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004544}
4545
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004546bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004547 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004548 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004549 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4550 if ((image_format_features & desired) != desired) {
4551 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004552 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004553 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004554 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4555 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4556 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004557 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004558 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004559 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004560 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4561 "with tiling %s.",
4562 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004563 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004564 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004565 }
4566 }
4567 return skip;
4568}
4569
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004570bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004571 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004572 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004573 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004574 // layerCount must not be zero
4575 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004576 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004577 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004578 }
4579 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004580 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004581 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004582 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004583 }
4584 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004585 if ((apsect_mask & VK_IMAGE_ASPECT_COLOR_BIT) && (apsect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004586 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004587 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4588 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4589 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004590 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004591 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4592 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4593 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004594 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004595 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4596 member);
4597 }
Cort Strattond619a302018-05-17 19:46:32 -07004598 return skip;
4599}
4600
Mark Lobodzinski96210742017-02-09 10:33:46 -07004601// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4602// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004603bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004604 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004605 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004606 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004607}
4608
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004609bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004610 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004611 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004612
4613 const VkDeviceSize &range = pCreateInfo->range;
4614 if (range != VK_WHOLE_SIZE) {
4615 // Range must be greater than 0
4616 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004617 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004618 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004619 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4620 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004621 }
4622 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004623 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4624 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004625 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004626 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004627 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4628 "(%" PRIu32 ").",
4629 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004630 }
4631 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004632 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004633 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004634 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004635 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4636 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4637 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004638 }
4639 // The sum of range and offset must be less than or equal to the size of buffer
4640 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004641 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004642 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004643 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4644 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4645 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004646 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004647 } else {
4648 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4649
4650 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4651 // VkPhysicalDeviceLimits::maxTexelBufferElements
4652 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4653 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004654 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004655 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4656 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4657 "), divided by the element size of the format (%" PRIu32
4658 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4659 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4660 device_limits->maxTexelBufferElements);
4661 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004662 }
4663 return skip;
4664}
4665
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004666bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004667 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004668 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004669 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4670 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004671 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004672 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004673 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4674 "be supported for uniform texel buffers",
4675 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004676 }
4677 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4678 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004679 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004680 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004681 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4682 "be supported for storage texel buffers",
4683 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004684 }
4685 return skip;
4686}
4687
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004688bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004689 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004690 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004691
Dave Houltond8ed0212018-05-16 17:18:24 -06004692 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004693
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004694 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004695 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004696 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004697 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004698 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4699 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004700 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004701 }
4702 }
4703
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004704 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004705 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004706 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004707 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004708 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004709 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4710 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004711 }
4712 }
4713
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004714 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4715 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4716 if (pCreateInfo->flags &
4717 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4718 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4719 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4720 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4721 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4722 }
4723 }
4724
Mike Schuchardt2df08912020-12-15 16:28:09 -08004725 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004726 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4727 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004728 skip |= LogError(
4729 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004730 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004731 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004732 }
4733
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004734 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004735 const char *vuid = device_extensions.vk_khr_get_physical_device_properties2 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4736 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004737 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004738 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004739 }
4740
sfricke-samsungedce77a2020-07-03 22:35:13 -07004741 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4742 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4743 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4744 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4745 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4746 }
4747 const VkBufferCreateFlags invalid_flags =
4748 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4749 if ((pCreateInfo->flags & invalid_flags) != 0) {
4750 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4751 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4752 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4753 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4754 }
4755 }
4756
Mark Lobodzinski96210742017-02-09 10:33:46 -07004757 return skip;
4758}
4759
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004760bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004761 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004762 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004763 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004764 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4765 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004766 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004767 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4768 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004769 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004770 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4771 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4772 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004773
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004774 // Buffer view offset must be less than the size of buffer
4775 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004776 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004777 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004778 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4779 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004780 }
4781
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004782 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004783 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4784 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4785 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004786 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4787 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004788 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004789 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004790 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4791 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004792 }
4793
4794 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004795 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4796 if ((element_size % 3) == 0) {
4797 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004798 }
4799 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004800 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004801 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4802 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004803 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004804 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004805 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004806 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004807 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004808 "vkCreateBufferView(): If buffer was created with usage containing "
4809 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004810 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4811 ") must be a multiple of the lesser of "
4812 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4813 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4814 "(%" PRId32
4815 ") is VK_TRUE, the size of a texel of the requested format. "
4816 "If the size of a texel is a multiple of three bytes, then the size of a "
4817 "single component of format is used instead",
4818 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4819 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4820 }
4821 }
4822 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004823 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004824 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4825 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004826 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004827 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004828 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004829 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004830 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004831 "vkCreateBufferView(): If buffer was created with usage containing "
4832 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004833 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4834 ") must be a multiple of the lesser of "
4835 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4836 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4837 "(%" PRId32
4838 ") is VK_TRUE, the size of a texel of the requested format. "
4839 "If the size of a texel is a multiple of three bytes, then the size of a "
4840 "single component of format is used instead",
4841 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4842 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4843 }
4844 }
4845 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004846
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004847 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004848
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004849 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004850 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004851 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004852}
4853
Mark Lobodzinski602de982017-02-09 11:01:33 -07004854// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004855bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004856 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004857 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004858 const IMAGE_STATE *image_state = GetImageState(image);
4859 // checks color format and (single-plane or non-disjoint)
4860 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004861 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004862 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004863 skip |= LogError(
4864 image, vuid,
4865 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4866 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004867 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004868 skip |= LogError(image, vuid,
4869 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4870 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4871 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004872 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004873 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004874 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004875 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004876 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4877 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4878 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004879 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004880 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004881 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4882 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4883 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004884 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004885 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004886 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004887 skip |= LogError(image, vuid,
4888 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4889 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4890 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004891 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004892 skip |= LogError(image, vuid,
4893 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4894 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4895 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004896 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004897 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004898 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004899 skip |= LogError(image, vuid,
4900 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4901 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4902 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004903 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004904 skip |= LogError(image, vuid,
4905 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4906 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4907 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004908 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004909 } else if (FormatIsMultiplane(format)) {
4910 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4911 if (3 == FormatPlaneCount(format)) {
4912 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4913 }
4914 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004915 skip |= LogError(image, vuid,
4916 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4917 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4918 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004919 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004920 }
4921 return skip;
4922}
4923
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004924bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4925 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004926 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004927 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004928 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004929
4930 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004931 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004932 skip |= LogError(image, errorCodes.base_mip_err,
4933 "%s: %s.baseMipLevel (= %" PRIu32
4934 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4935 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004936 }
Petr Kraus4d718682017-05-18 03:38:41 +02004937
Petr Krausffa94af2017-08-08 21:46:02 +02004938 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4939 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004940 skip |=
4941 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004942 } else {
4943 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004944
Petr Krausffa94af2017-08-08 21:46:02 +02004945 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004946 skip |= LogError(image, errorCodes.mip_count_err,
4947 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4948 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4949 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4950 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004951 }
Petr Kraus4d718682017-05-18 03:38:41 +02004952 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004953 }
Petr Kraus4d718682017-05-18 03:38:41 +02004954
4955 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004956 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004957 skip |= LogError(image, errorCodes.base_layer_err,
4958 "%s: %s.baseArrayLayer (= %" PRIu32
4959 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4960 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004961 }
Petr Kraus4d718682017-05-18 03:38:41 +02004962
Petr Krausffa94af2017-08-08 21:46:02 +02004963 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4964 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004965 skip |=
4966 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004967 } else {
4968 const uint64_t necessary_layer_count =
4969 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004970
Petr Krausffa94af2017-08-08 21:46:02 +02004971 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004972 skip |= LogError(image, errorCodes.layer_count_err,
4973 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4974 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4975 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4976 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004977 }
Petr Kraus4d718682017-05-18 03:38:41 +02004978 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004979 }
Petr Kraus4d718682017-05-18 03:38:41 +02004980
ziga-lunargb4e90752021-08-02 13:58:29 +02004981 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4982 if (subresourceRange.aspectMask &
4983 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4984 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4985 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4986 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4987 cmd_name);
4988 }
4989 }
4990
Mark Lobodzinski602de982017-02-09 11:01:33 -07004991 return skip;
4992}
4993
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004994bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004995 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004996 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004997 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004998 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004999 bool is_3_d_to_2_d_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
Petr Krausffa94af2017-08-08 21:46:02 +02005000
David McFarland2853f2f2020-11-30 15:50:39 -04005001 uint32_t image_layer_count;
5002
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005003 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005004 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06005005 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04005006 image_layer_count = extent.depth;
5007 } else {
5008 image_layer_count = image_state->createInfo.arrayLayers;
5009 }
5010
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005011 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005012
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005013 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5014 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5015 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5016 subresource_range_error_codes.base_layer_err =
5017 is_khr_maintenance1
5018 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
5019 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
5020 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
5021 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5022 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
5023 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005024
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005025 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005026 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005027 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005028}
5029
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005030bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005031 const VkImageSubresourceRange &subresourceRange,
5032 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005033 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5034 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5035 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5036 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5037 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005038
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005039 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005040 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005041 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005042}
5043
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005044bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005045 const VkImageSubresourceRange &subresourceRange,
5046 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005047 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5048 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5049 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5050 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5051 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005052
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005053 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005054 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005055 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005056}
5057
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005058bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005059 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005060 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005061 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005062 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005063}
5064
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005065namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005066using sync_vuid_maps::GetBarrierQueueVUID;
5067using sync_vuid_maps::kQueueErrorSummary;
5068using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005069
5070class ValidatorState {
5071 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005072 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005073 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5074 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005075 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005076 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005077 barrier_handle_(barrier_handle),
5078 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005079 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5080 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5081
5082 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5083 // One and two family versions, in the single family version, Vu holds the name of the passed parameter
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005084 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5085 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005086 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005087 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5088 loc_.Message().c_str(), GetTypeString(),
5089 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5090 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005091 }
5092
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005093 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5094 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005095 const char *src_annotation = GetFamilyAnnotation(src_family);
5096 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5097 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005098 objects_, val_code,
5099 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5100 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5101 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005102 }
5103
5104 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5105 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5106 // application input.
5107 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5108 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005109 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005110 uint32_t queue_family = queue_state->queueFamilyIndex;
5111 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005112 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005113 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5114 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5115 return device_data->LogError(
5116 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005117 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005118 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005119 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005120 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005121 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005122 }
5123 return false;
5124 }
5125 // Logical helpers for semantic clarity
5126 inline bool KhrExternalMem() const { return mem_ext_; }
5127 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5128 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5129 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5130 }
5131
5132 // Helpers for LogMsg
5133 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5134
5135 // Descriptive text for the various types of queue family index
5136 const char *GetFamilyAnnotation(uint32_t family) const {
5137 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5138 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5139 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5140 const char *valid = " (VALID)";
5141 const char *invalid = " (INVALID)";
5142 switch (family) {
5143 case VK_QUEUE_FAMILY_EXTERNAL:
5144 return external;
5145 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5146 return foreign;
5147 case VK_QUEUE_FAMILY_IGNORED:
5148 return ignored;
5149 default:
5150 if (IsValid(family)) {
5151 return valid;
5152 }
5153 return invalid;
5154 };
5155 }
5156 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5157 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5158
5159 protected:
5160 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005161 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005162 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005163 const VulkanTypedHandle barrier_handle_;
5164 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005165 const uint32_t limit_;
5166 const bool mem_ext_;
5167};
5168
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005169bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005170 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5171 bool skip = false;
5172
5173 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5174 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5175 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5176 if (val.KhrExternalMem()) {
5177 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005178 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5179 // this requirement is removed by VK_KHR_synchronization2
5180 if (!(src_ignored || dst_ignored) && !sync2) {
5181 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005182 }
5183 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5184 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005185 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005186 }
5187 } else {
5188 // VK_SHARING_MODE_EXCLUSIVE
5189 if (src_queue_family != dst_queue_family) {
5190 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005191 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005192 }
5193 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005194 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005195 }
5196 }
5197 }
5198 } else {
5199 // No memory extension
5200 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005201 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5202 // this requirement is removed by VK_KHR_synchronization2
5203 if ((!src_ignored || !dst_ignored) && !sync2) {
5204 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005205 }
5206 } else {
5207 // VK_SHARING_MODE_EXCLUSIVE
5208 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005209 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005210 }
5211 }
5212 }
5213 return skip;
5214}
5215} // namespace barrier_queue_families
5216
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005217bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005218 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005219 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5220 uint32_t dst_queue_family) {
5221 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005222 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005223 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5224}
5225
5226// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005227template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005228bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5229 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005230 // State data is required
5231 if (!state_data) {
5232 return false;
5233 }
5234
5235 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005236 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005237 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005238 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5239 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005240 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005241}
5242
5243// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005244template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005245bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5246 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005247 // State data is required
5248 if (!state_data) {
5249 return false;
5250 }
5251
5252 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005253 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005254 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005255 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5256 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005257 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5258}
5259
5260template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005261bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005262 const Barrier &mem_barrier) const {
5263 using sync_vuid_maps::BufferError;
5264 using sync_vuid_maps::GetBufferBarrierVUID;
5265
5266 bool skip = false;
5267
5268 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5269
5270 // Validate buffer barrier queue family indices
5271 auto buffer_state = GetBufferState(mem_barrier.buffer);
5272 if (buffer_state) {
5273 auto buf_loc = loc.dot(Field::buffer);
5274 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005275 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005276
5277 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5278
5279 auto buffer_size = buffer_state->createInfo.size;
5280 if (mem_barrier.offset >= buffer_size) {
5281 auto offset_loc = loc.dot(Field::offset);
5282 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5283
5284 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5285 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5286 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5287 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5288 auto size_loc = loc.dot(Field::size);
5289 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5290 skip |= LogError(objects, vuid,
5291 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5292 ".",
5293 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5294 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5295 }
5296 if (mem_barrier.size == 0) {
5297 auto size_loc = loc.dot(Field::size);
5298 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5299 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5300 report_data->FormatHandle(mem_barrier.buffer).c_str());
5301 }
5302 }
5303 return skip;
5304}
5305
5306template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005307bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005308 const Barrier &mem_barrier) const {
5309 bool skip = false;
5310
5311 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5312
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005313 bool is_ilt = true;
5314 if (enabled_features.synchronization2_features.synchronization2) {
5315 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5316 }
5317
5318 if (is_ilt) {
5319 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5320 auto layout_loc = loc.dot(Field::newLayout);
5321 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5322 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005323 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005324 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005325 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005326 }
5327
5328 auto image_data = GetImageState(mem_barrier.image);
5329 if (image_data) {
5330 auto image_loc = loc.dot(Field::image);
5331
John Zulaufbea70432021-02-23 07:03:12 -07005332 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005333
5334 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5335
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005336 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005337 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005338
5339 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5340 }
5341 return skip;
5342}
5343
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005344bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5345 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5346 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005347 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5348 const VkImageMemoryBarrier *pImageMemBarriers) const {
5349 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005350 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005351
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005352 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5353 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005354 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005355 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005356 }
5357 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5358 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005359 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005360 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005361 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5362 }
5363 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005364 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005365 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5366 }
5367 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5368 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005369 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005370 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005371 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5372 }
5373 return skip;
5374}
5375
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005376bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005377 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005378 bool skip = false;
5379
5380 if (cb_state->activeRenderPass) {
5381 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5382 if (skip) return true; // Early return to avoid redundant errors from below calls
5383 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005384 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5385 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005386 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005387 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005388 }
5389 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5390 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005391 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005392 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005393 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5394 }
5395 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005396 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005397 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5398 }
5399
5400 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5401 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005402 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005403 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005404 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5405 }
5406
5407 return skip;
5408}
5409
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005410// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005411template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005412bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5413 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005414 VkPipelineStageFlags dst_stage_mask) const {
5415 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005416 assert(cb_state);
5417 auto queue_flags = cb_state->GetQueueFlags();
5418
5419 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005420 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5421 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005422 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005423 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5424 }
5425 return skip;
5426}
5427
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005428// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005429template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005430bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5431 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005432 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005433 assert(cb_state);
5434 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005435
Jeremy Gebbenefead332021-06-18 08:22:44 -06005436 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005437 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005438 skip |=
5439 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5440 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005441
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005442 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005443 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005444 skip |=
5445 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5446 }
5447 return skip;
5448}
5449
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005450// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5451// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5452// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5453static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5454 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5455}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005456
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005457bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5458 const VkSubpassDependency2 &dependency) const {
5459 bool skip = false;
5460 Location loc = in_loc;
5461 VkMemoryBarrier2KHR converted_barrier;
5462 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5463
5464 if (mem_barrier && enabled_features.synchronization2_features.synchronization2) {
5465 if (dependency.srcAccessMask != 0) {
5466 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5467 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5468 loc.dot(Field::srcAccessMask).Message().c_str());
5469 }
5470 if (dependency.dstAccessMask != 0) {
5471 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5472 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5473 loc.dot(Field::dstAccessMask).Message().c_str());
5474 }
5475 if (dependency.srcStageMask != 0) {
5476 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5477 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5478 loc.dot(Field::srcStageMask).Message().c_str());
5479 }
5480 if (dependency.dstStageMask != 0) {
5481 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5482 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5483 loc.dot(Field::dstStageMask).Message().c_str());
5484 }
5485 loc = in_loc.dot(Field::pNext);
5486 converted_barrier = *mem_barrier;
5487 } else {
5488 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005489 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5490 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5491 loc.Message().c_str());
5492 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005493 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5494 converted_barrier.srcStageMask = dependency.srcStageMask;
5495 converted_barrier.dstStageMask = dependency.dstStageMask;
5496 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5497 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005498 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005499 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5500 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5501 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5502 converted_barrier.srcStageMask);
5503
5504 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5505 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5506 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5507 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005508 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005509}
5510
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005511bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5512 const VkImageUsageFlags image_usage) const {
5513 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5514 bool skip = false;
5515
5516 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5517 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5518
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005519 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005520 // AHB image view and image share same feature sets
5521 tiling_features = image_state->format_features;
5522 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5523 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5524 assert(device_extensions.vk_ext_image_drm_format_modifier);
5525 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5526 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005527 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005528
5529 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5530 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5531 nullptr};
5532 format_properties_2.pNext = (void *)&drm_properties_list;
5533 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5534
nyorain38a9d232021-03-06 13:06:12 +01005535 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5536 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5537 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5538
5539 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5540
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005541 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5542 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5543 0) {
5544 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5545 }
5546 }
5547 } else {
5548 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5549 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5550 : format_properties.optimalTilingFeatures;
5551 }
5552
5553 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005554 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005555 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5556 "physical device.",
5557 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5558 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005559 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005560 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5561 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5562 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5563 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005564 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005565 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5566 "VK_IMAGE_USAGE_STORAGE_BIT.",
5567 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5568 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005569 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005570 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5571 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5572 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5573 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5574 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005575 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005576 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5577 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5578 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5579 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5580 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005581 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005582 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5583 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5584 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005585 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5586 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5587 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005588 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005589 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5590 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5591 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5592 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005593 }
5594
5595 return skip;
5596}
5597
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005598bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005599 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005600 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005601 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005602 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005603 skip |=
5604 ValidateImageUsageFlags(image_state,
5605 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5606 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005607 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5608 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5609 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005610 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005611 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005612 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005613 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005614 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005615 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005616 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005617 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005618
5619 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5620 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005621 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005622 VkFormat view_format = pCreateInfo->format;
5623 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005624 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005625 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005626 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005627
Dave Houltonbd2e2622018-04-10 16:41:14 -06005628 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005629 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005630 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005631 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005632 if (!device_extensions.vk_ext_separate_stencil_usage) {
5633 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005634 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5635 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5636 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005637 }
5638 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005639 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005640 if (image_stencil_struct == nullptr) {
5641 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005642 skip |= LogError(
5643 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005644 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5645 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5646 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5647 }
5648 } else {
5649 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5650 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5651 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005652 skip |= LogError(
5653 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005654 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5655 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5656 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5657 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5658 }
5659 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5660 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005661 skip |= LogError(
5662 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005663 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5664 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5665 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5666 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5667 }
5668 }
5669 }
5670 }
5671
Dave Houltonbd2e2622018-04-10 16:41:14 -06005672 image_usage = chained_ivuci_struct->usage;
5673 }
5674
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005675 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5676 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5677 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5678 bool foundFormat = false;
5679 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5680 if (format_list_info->pViewFormats[i] == view_format) {
5681 foundFormat = true;
5682 break;
5683 }
5684 }
5685 if (foundFormat == false) {
5686 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5687 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5688 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5689 string_VkFormat(view_format));
5690 }
5691 }
5692
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005693 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5694 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005695 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005696 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005697 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005698 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005699 std::stringstream ss;
5700 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005701 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005702 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005703 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005704 }
5705 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005706 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005707 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
sfricke-samsung9a65d282021-03-17 23:41:59 -07005708 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5709 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5710 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5711 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005712 const char *error_vuid;
5713 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5714 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5715 } else if ((device_extensions.vk_khr_maintenance2) &&
5716 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5717 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5718 } else if ((!device_extensions.vk_khr_maintenance2) &&
5719 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5720 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5721 } else {
5722 // both enabled
5723 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5724 }
Dave Houltonc7988072018-04-16 11:46:56 -06005725 std::stringstream ss;
5726 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005727 << " is not in the same format compatibility class as "
5728 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005729 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5730 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005731 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005732 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005733 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005734 }
5735 } else {
5736 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005737 // Unless it is a multi-planar color bit aspect
5738 if ((image_format != view_format) &&
5739 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5740 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5741 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005742 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005743 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005744 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005745 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005746 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005747 }
5748 }
5749
5750 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005751 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005752
sfricke-samsung20a8a372021-07-14 06:12:17 -07005753 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005754 switch (image_type) {
5755 case VK_IMAGE_TYPE_1D:
5756 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005757 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5758 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5759 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005760 }
5761 break;
5762 case VK_IMAGE_TYPE_2D:
5763 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5764 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5765 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005766 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5767 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5768 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005769 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005770 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5771 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5772 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005773 }
5774 }
5775 break;
5776 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005777 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005778 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5779 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005780 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005781 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005782 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005783 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5784 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005785 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005786 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5787 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005788 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005789 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005790 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5791 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5792 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5793 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005794 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5795 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5796 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5797 "levelCount of 1 but it is %u.",
5798 string_VkImageViewType(view_type), string_VkImageType(image_type),
5799 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005800 }
5801 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005802 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5803 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5804 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005805 }
5806 }
5807 } else {
5808 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005809 // Help point to VK_KHR_maintenance1
5810 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5811 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5812 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5813 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5814 string_VkImageViewType(view_type), string_VkImageType(image_type));
5815 } else {
5816 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5817 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5818 string_VkImageViewType(view_type), string_VkImageType(image_type));
5819 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005820 }
5821 }
5822 break;
5823 default:
5824 break;
5825 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005826
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005827 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005828 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005829 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005830 }
5831
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005832 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005833
Tobias Hector6663c9b2020-11-05 10:18:02 +00005834 if (enabled_features.shading_rate_image.shadingRateImage) {
5835 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5836 if (view_format != VK_FORMAT_R8_UINT) {
5837 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5838 "vkCreateImageView() If image was created with usage containing "
5839 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5840 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005841 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005842 }
5843
5844 if (enabled_features.shading_rate_image.shadingRateImage ||
5845 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5846 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5847 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5848 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5849 "vkCreateImageView() If image was created with usage containing "
5850 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5851 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5852 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005853 }
5854 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005855
Tobias Hector6663c9b2020-11-05 10:18:02 +00005856 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5857 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005858 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005859 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5860 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005861 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005862 }
5863
sfricke-samsung20a8a372021-07-14 06:12:17 -07005864 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5865 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5866 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005867 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5868 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005869 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005870 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005871 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005872 skip |= LogError(
5873 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5874 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005875 remaining_layers);
5876 }
5877 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5878 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5879 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5880 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5881 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5882 string_VkImageViewType(view_type), remaining_layers);
5883 }
5884 } else {
5885 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5886 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5887 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5888 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5889 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5890 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005891 }
5892 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005893
5894 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5895 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005896 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005897 "vkCreateImageView(): If image was created with usage containing "
5898 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5899 pCreateInfo->subresourceRange.levelCount);
5900 }
5901 }
5902 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5903 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005904 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005905 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5906 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5907 }
5908 } else {
5909 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5910 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5911 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005912 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005913 "vkCreateImageView(): If image was created with usage containing "
5914 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5915 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5916 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5917 }
5918 }
5919 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005920
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005921 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5922 if (pCreateInfo->subresourceRange.levelCount != 1) {
5923 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5924 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5925 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5926 pCreateInfo->subresourceRange.levelCount);
5927 }
5928 if (pCreateInfo->subresourceRange.layerCount != 1) {
5929 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5930 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5931 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5932 pCreateInfo->subresourceRange.layerCount);
5933 }
5934 }
5935
ziga-lunargc290c7f2021-07-31 22:01:46 +02005936 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(image_format) &&
5937 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5938 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5939 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5940 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5941 string_VkFormat(image_format));
5942 }
5943
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005944 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5945 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5946 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5947 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5948 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5949 }
5950 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5951 skip |=
5952 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5953 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5954 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5955 }
5956 }
Mike Schuchardtc57de4a2021-07-20 17:26:32 -07005957 if (device_extensions.vk_ext_fragment_density_map2) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005958 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005959 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005960 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5961 "vkCreateImageView(): If image was created with flags containing "
5962 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5963 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005964 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005965 }
5966 }
5967
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005968 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005969 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5970 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5971 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5972 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5973 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5974 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5975 }
5976 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005977
5978 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5979 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005980 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5981 // VK_COMPONENT_SWIZZLE_IDENTITY."
5982 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5983 // also be defined via R, G, B, A enums in the correct order.
5984 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005985 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005986 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005987 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5988 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5989 }
5990
5991 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5992 // disabled
5993 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5994 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5995 // spec. See Github issue #2361.
5996 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5997 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5998 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5999 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
6000 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6001 "vkCreateImageView (portability error): ImageView format must have"
6002 " the same number of components and bits per component as the Image's format");
6003 }
6004 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006005 }
6006 return skip;
6007}
6008
Jeff Leger178b1e52020-10-05 12:22:23 -04006009template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006010bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04006011 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006012 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006013 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6014 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
6015 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006016
6017 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6018 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
6019 VkDeviceSize src_min = UINT64_MAX;
6020 VkDeviceSize src_max = 0;
6021 VkDeviceSize dst_min = UINT64_MAX;
6022 VkDeviceSize dst_max = 0;
6023
6024 for (uint32_t i = 0; i < regionCount; i++) {
6025 src_min = std::min(src_min, pRegions[i].srcOffset);
6026 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
6027 dst_min = std::min(dst_min, pRegions[i].dstOffset);
6028 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
6029
6030 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
6031 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006032 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006033 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006034 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
6035 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006036 }
6037
6038 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
6039 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006040 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006041 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006042 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
6043 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006044 }
6045
6046 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6047 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006048 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006049 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006050 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006051 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006052 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006053 }
6054
6055 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6056 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006057 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006058 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006059 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006060 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006061 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006062 }
6063 }
6064
6065 // The union of the source regions, and the union of the destination regions, must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006066 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006067 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006068 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006069 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04006070 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006071 }
6072 }
6073
6074 return skip;
6075}
6076
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006077bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006078 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006079 const auto cb_node = GetCBState(commandBuffer);
6080 const auto src_buffer_state = GetBufferState(srcBuffer);
6081 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006082
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006083 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006084 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6085 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006086 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006087 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006088 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6089 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006090 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006091 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6092 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006093 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Jeff Leger178b1e52020-10-05 12:22:23 -04006094 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006095 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6096 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6097 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006098 return skip;
6099}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006100
Jeff Leger178b1e52020-10-05 12:22:23 -04006101bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6102 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6103 const auto cb_node = GetCBState(commandBuffer);
6104 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6105 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6106
6107 bool skip = false;
6108 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6109 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6110 // Validate that SRC & DST buffers have correct usage flags set
6111 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6112 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6113 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6114 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6115 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6116 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006117 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
Jeff Leger178b1e52020-10-05 12:22:23 -04006118 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6119 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6120 skip |=
6121 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6122 skip |=
6123 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6124 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6125 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6126 return skip;
6127}
6128
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006129bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006130 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006131 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006132 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006133 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006134 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6135 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006136 }
6137 }
6138 return skip;
6139}
6140
Jeff Bolz5c801d12019-10-09 10:38:45 -05006141bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6142 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006143 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006144
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006145 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006146 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006147 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006148 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006149 }
6150 return skip;
6151}
6152
Jeff Bolz5c801d12019-10-09 10:38:45 -05006153bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006154 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006155
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006156 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006157 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006158 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006159 }
6160 return skip;
6161}
6162
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006163void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6164 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6165 if (buffer_state) {
6166 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
6167 if (itr != buffer_address_map_.end()) {
6168 buffer_address_map_.erase(itr);
6169 }
6170 }
6171 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6172}
6173
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006174bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006175 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006176 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006177 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006178 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006179 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006180 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006181 }
6182 return skip;
6183}
6184
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006185bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006186 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006187 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006188 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006189 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006190 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006191 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006192 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006193 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6194 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006195
sfricke-samsung022fa252020-07-24 03:26:16 -07006196 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6197 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6198
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006199 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006200 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6201 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6202 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6203 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006204 }
6205
6206 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006207 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6208 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6209 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6210 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006211 }
6212
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006213 return skip;
6214}
6215
Jeff Leger178b1e52020-10-05 12:22:23 -04006216template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006217bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006218 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006219 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006220 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006221 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6222 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006223
sfricke-samsung125d2b42020-05-28 06:32:43 -07006224 assert(image_state != nullptr);
6225 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006226
6227 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006228 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006229 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6230 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006231 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006232 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6233 "and 1, respectively.",
6234 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006235 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006236 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006237
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006238 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6239 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006240 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006241 "%s: pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006242 "must be 0 and 1, respectively.",
6243 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006244 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006245 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006246
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006247 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6248 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006249 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006250 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006251 "For 3D images these must be 0 and 1, respectively.",
6252 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006253 }
6254 }
6255
6256 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006257 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006258 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6259 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006260
sfricke-samsung8feecc12021-01-23 03:28:38 -08006261 if (FormatIsDepthOrStencil(image_format)) {
6262 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006263 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006264 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6265 " must be a multiple 4 if using a depth/stencil format (%s).",
6266 function, i, bufferOffset, string_VkFormat(image_format));
6267 }
6268 } else {
6269 // If not depth/stencil and not multi-plane
6270 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6271 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6272 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6273 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006274 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006275 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6276 " must be a multiple of this format's texel size (%" PRIu32 ").",
6277 function, i, bufferOffset, element_size);
6278 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006279 }
6280
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006281 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6282 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006283 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006284 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006285 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006286 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006287 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006288 }
6289
6290 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6291 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006292 vuid =
6293 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006294 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006295 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006296 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6297 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006298 }
6299
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006300 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006301 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006302 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006303 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006304 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6305 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006306 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006307 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006308 "zero or <= image subresource width (%d).",
6309 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006310 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006311 }
6312
6313 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006314 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006315 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6316 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006317 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006318 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006319 "zero or <= image subresource height (%d).",
6320 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006321 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006322 }
6323
6324 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006325 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006326 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6327 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006328 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006329 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006330 "zero or <= image subresource depth (%d).",
6331 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006332 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006333 }
6334
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006335 // subresource aspectMask must have exactly 1 bit set
6336 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006337 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006338 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006339 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006340 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006341 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006342 }
6343
6344 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006345 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006346 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006347 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006348 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6349 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006350 }
6351
6352 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006353 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6354 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006355
6356 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006357 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006358 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006359 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006360 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04006361 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006362 }
6363
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006364 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006365 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006366 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006367 image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006368 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006369 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006370 }
6371
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006372 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006373 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6374 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6375 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006376 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006377 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006378 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006379 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6380 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006381 }
6382
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006383 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006384 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006385 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006386 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006387 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Petr Krausb0d5e592021-05-21 23:37:11 +02006388 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ").",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006389 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006390 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006391
6392 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006393 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006394 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006395 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006396 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006397 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006398 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006399 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6400 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006401 }
6402
6403 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006404 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006405 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006406 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006407 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006408 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006409 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6410 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006411 }
6412
6413 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006414 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006415 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006416 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006417 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006418 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006419 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6420 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006421 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006422 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006423
6424 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006425 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006426 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006427 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006428 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006429 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006430 "format has three planes.",
6431 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006432 }
6433
6434 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006435 if (0 ==
6436 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006437 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006438 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006439 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6440 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006441 } else {
6442 // Know aspect mask is valid
6443 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6444 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006445 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006446 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006447 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006448 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006449 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006450 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006451 string_VkFormat(compatible_format));
6452 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006453 }
6454 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006455
6456 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6457 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6458 assert(command_pool != nullptr);
6459 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6460 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6461 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006462 LogObjectList objlist(cb_node->commandBuffer());
6463 objlist.add(command_pool->commandPool());
6464 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006465 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6466 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6467 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6468 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006469 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6470 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006471 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006472 }
6473
6474 return skip;
6475}
6476
Jeff Leger178b1e52020-10-05 12:22:23 -04006477template <typename BufferImageCopyRegionType>
6478bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6479 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006480 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006481 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006482
6483 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006484 VkExtent3D extent = pRegions[i].imageExtent;
6485 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006486
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006487 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6488 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006489 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006490 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6491 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006492 }
6493
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006494 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006495
6496 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
unknown948b6ba2019-09-19 17:32:54 -06006497 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006498 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006499 if (image_extent.width % block_extent.width) {
6500 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6501 }
6502 if (image_extent.height % block_extent.height) {
6503 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6504 }
6505 if (image_extent.depth % block_extent.depth) {
6506 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6507 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006508 }
6509
Dave Houltonfc1a4052017-04-27 14:32:45 -06006510 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006511 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006512 }
6513 }
6514
6515 return skip;
6516}
6517
Jeff Leger178b1e52020-10-05 12:22:23 -04006518template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006519bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006520 const BufferImageCopyRegionType *pRegions, const char *func_name,
6521 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006522 bool skip = false;
6523
6524 VkDeviceSize buffer_size = buff_state->createInfo.size;
6525
6526 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006527 VkDeviceSize max_buffer_offset =
6528 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6529 if (buffer_size < max_buffer_offset) {
6530 skip |=
Petr Krausb0d5e592021-05-21 23:37:11 +02006531 LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes.", func_name, i, buffer_size);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006532 }
6533 }
6534
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006535 return skip;
6536}
6537
Jeff Leger178b1e52020-10-05 12:22:23 -04006538template <typename BufferImageCopyRegionType>
6539bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6540 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6541 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006542 const auto cb_node = GetCBState(commandBuffer);
6543 const auto src_image_state = GetImageState(srcImage);
6544 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006545
Jeff Leger178b1e52020-10-05 12:22:23 -04006546 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6547 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6548 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6549 const char *vuid;
6550
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006551 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006552
6553 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006554 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006555
6556 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006557 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006558
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006559 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006560
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006561 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006562 vuid =
6563 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6564 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6565 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6566 "or transfer capabilities.",
6567 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006568 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006569 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6570 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6571 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6572 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006573
Jeff Leger178b1e52020-10-05 12:22:23 -04006574 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6575 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6576 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6577
6578 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6579 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6580 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6581 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006582
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006583 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006584 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6585 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006586 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006587 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6588 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006589 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006590 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6591 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6592 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6593 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6594 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6595 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006596
6597 // Validation for VK_EXT_fragment_density_map
6598 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006599 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006600 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006601 "%s: srcImage must not have been created with flags containing "
6602 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6603 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006604 }
6605
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006606 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006607 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6608 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006609 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006610 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006611
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006612 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04006613 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6614 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6615 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6616 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6617
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006618 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006619 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6620 vuid =
6621 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006622 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006623 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6624 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6625 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6626 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6627 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6628 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6629 "imageSubresource", vuid);
6630 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6631 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006632 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006633 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006634 }
6635 return skip;
6636}
6637
Jeff Leger178b1e52020-10-05 12:22:23 -04006638bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6639 VkBuffer dstBuffer, uint32_t regionCount,
6640 const VkBufferImageCopy *pRegions) const {
6641 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6642 COPY_COMMAND_VERSION_1);
6643}
6644
6645bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6646 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6647 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6648 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6649 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6650}
6651
John Zulauf1686f232019-07-09 16:27:11 -06006652void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6653 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6654 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6655
6656 auto cb_node = GetCBState(commandBuffer);
6657 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006658 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006659 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006660 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006661 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006662}
6663
Jeff Leger178b1e52020-10-05 12:22:23 -04006664void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6665 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6666 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6667
6668 auto cb_node = GetCBState(commandBuffer);
6669 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6670 // Make sure that all image slices record referenced layout
6671 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6672 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6673 pCopyImageToBufferInfo->srcImageLayout);
6674 }
6675}
6676
6677template <typename RegionType>
6678bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6679 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6680 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006681 const auto cb_node = GetCBState(commandBuffer);
6682 const auto src_buffer_state = GetBufferState(srcBuffer);
6683 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006684
Jeff Leger178b1e52020-10-05 12:22:23 -04006685 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6686 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6687 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6688 const char *vuid;
6689
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006690 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006691
6692 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006693 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006694
Jeff Leger178b1e52020-10-05 12:22:23 -04006695 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6696 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6697 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6698 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6699
6700 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6701 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6702 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6703 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6704 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6705 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6706 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6707 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6708 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006709 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006710 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6711 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006712 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006713 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6714 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6715 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6716 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6717 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6718 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006719
6720 // Validation for VK_EXT_fragment_density_map
6721 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006722 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006723 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006724 "%s: dstImage must not have been created with flags containing "
6725 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6726 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006727 }
6728
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006729 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006730 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6731 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006732 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006733 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006734
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006735 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04006736 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6737 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6738 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6739 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6740
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006741 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006742 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6743 vuid =
6744 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006745 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006746 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6747 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6748 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6749 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6750 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6751 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6752 "imageSubresource", vuid);
6753 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6754 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006755 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006756 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006757
6758 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6759 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6760 assert(command_pool != nullptr);
6761 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6762 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6763 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6764 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6765 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006766 LogObjectList objlist(cb_node->commandBuffer());
6767 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006768 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6769 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006770 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006771 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6772 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6773 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006774 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6775 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006776 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006777 }
6778 return skip;
6779}
6780
Jeff Leger178b1e52020-10-05 12:22:23 -04006781bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6782 VkImageLayout dstImageLayout, uint32_t regionCount,
6783 const VkBufferImageCopy *pRegions) const {
6784 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6785 COPY_COMMAND_VERSION_1);
6786}
6787
6788bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6789 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6790 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6791 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6792 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6793}
6794
John Zulauf1686f232019-07-09 16:27:11 -06006795void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6796 VkImageLayout dstImageLayout, uint32_t regionCount,
6797 const VkBufferImageCopy *pRegions) {
6798 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6799
6800 auto cb_node = GetCBState(commandBuffer);
6801 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006802 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006803 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006804 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006805 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006806}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006807
Jeff Leger178b1e52020-10-05 12:22:23 -04006808void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6809 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6810 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6811
6812 auto cb_node = GetCBState(commandBuffer);
6813 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6814 // Make sure that all image slices are record referenced layout
6815 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6816 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6817 pCopyBufferToImageInfo2KHR->dstImageLayout);
6818 }
6819}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006820bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006821 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006822 bool skip = false;
6823 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6824
Dave Houlton1d960ff2018-01-19 12:17:05 -07006825 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006826 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6827 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6828 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006829 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6830 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006831 }
6832
John Zulaufa26d3c82019-08-14 16:09:08 -06006833 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006834 if (!image_entry) {
6835 return skip;
6836 }
6837
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006838 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6839 if (device_extensions.vk_ext_image_drm_format_modifier) {
6840 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6841 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006842 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6843 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6844 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006845 }
6846 } else {
6847 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006848 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6849 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006850 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006851 }
6852
Dave Houlton1d960ff2018-01-19 12:17:05 -07006853 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006854 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006855 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6856 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6857 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006858 }
6859
Dave Houlton1d960ff2018-01-19 12:17:05 -07006860 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006861 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006862 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6863 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6864 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006865 }
6866
Dave Houlton1d960ff2018-01-19 12:17:05 -07006867 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006868 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006869 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6870 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006871 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006872 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6873 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006874 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006875 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6876 }
6877 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006878 skip |= LogError(image, vuid,
6879 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6880 ") must be a single-plane specifier flag.",
6881 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006882 }
6883 } else if (FormatIsColor(img_format)) {
6884 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006885 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6886 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6887 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006888 }
6889 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006890 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006891 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006892 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006893 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6894 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6895 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6896 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006897 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6898 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6899 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006900 }
6901 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006902
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006903 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006904 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006905 }
6906
Mike Weiblen672b58b2017-02-21 14:32:53 -07006907 return skip;
6908}
sfricke-samsung022fa252020-07-24 03:26:16 -07006909
6910// Validates the image is allowed to be protected
6911bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006912 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006913 bool skip = false;
6914 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006915 LogObjectList objlist(cb_state->commandBuffer());
6916 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006917 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006918 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6919 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006920 }
6921 return skip;
6922}
6923
6924// Validates the image is allowed to be unprotected
6925bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006926 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006927 bool skip = false;
6928 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006929 LogObjectList objlist(cb_state->commandBuffer());
6930 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006931 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006932 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6933 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006934 }
6935 return skip;
6936}
6937
6938// Validates the buffer is allowed to be protected
6939bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006940 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006941 bool skip = false;
6942 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006943 LogObjectList objlist(cb_state->commandBuffer());
6944 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006945 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006946 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6947 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006948 }
6949 return skip;
6950}
6951
6952// Validates the buffer is allowed to be unprotected
6953bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006954 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006955 bool skip = false;
6956 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006957 LogObjectList objlist(cb_state->commandBuffer());
6958 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006959 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006960 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6961 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006962 }
6963 return skip;
6964}