blob: 3108cb5180d9c87aa2feb3ce36cceb7dbe308b12 [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 Gebbene60d4172021-02-02 15:42:15 -070044#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070045
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070046// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070047static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070048 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070049 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
50 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070051 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
52 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
53 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
54 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
55 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070056 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070057 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
58 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
59 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
60 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
61 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070062 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070063 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
64 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
65 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
66 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
67 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070068 {"00197", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070069 "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
70 "VUID-vkCmdCopyImageToBuffer-imageOffset-00197",
71 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00197",
72 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
73 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070074 {"00198", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070075 "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
76 "VUID-vkCmdCopyImageToBuffer-imageOffset-00198",
77 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00198",
78 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
79 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070080 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070081 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
82 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
83 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
84 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
85 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070086 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070087 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
88 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
89 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
90 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
91 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070092 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070093 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
94 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
95 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
96 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
97 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070098 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070099 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
100 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
101 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
102 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
103 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700104 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700105 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
106 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
107 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
108 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
109 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700110 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700111 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
112 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
113 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
114 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
115 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700116 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700117 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
118 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
119 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
120 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
121 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700122 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700123 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
124 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
125 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
126 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
127 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700128 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700129 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
130 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
131 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
132 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
133 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700134 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700135 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
136 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
137 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
138 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
139 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700140 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700141 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
142 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
143 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
144 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
145 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700146 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700147 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
148 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
149 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
150 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
151 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700152 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700153 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
154 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
155 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
156 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800157 }},
158 {"04052", {
159 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
160 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
161 "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04052",
162 "VUID-VkCopyImageToBufferInfo2KHR-commandBuffer-04052",
163 }},
164 {"04053", {
165 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
166 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
167 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-04053",
168 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700169 }}
170 };
171 // clang-format on
172
173 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700174 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
175 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700176 return copy_imagebuffer_vuid.at(id).at(index);
177}
178
David McFarland2853f2f2020-11-30 15:50:39 -0400179// Transfer VkImageSubresourceRange into VkImageSubresourceLayers struct
180static VkImageSubresourceLayers LayersFromRange(const VkImageSubresourceRange &subresource_range) {
181 VkImageSubresourceLayers subresource_layers;
182 subresource_layers.aspectMask = subresource_range.aspectMask;
183 subresource_layers.baseArrayLayer = subresource_range.baseArrayLayer;
184 subresource_layers.layerCount = subresource_range.layerCount;
185 subresource_layers.mipLevel = subresource_range.baseMipLevel;
186 return subresource_layers;
187}
188
John Zulauff660ad62019-03-23 07:16:05 -0600189// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
190static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
191 VkImageSubresourceRange subresource_range;
192 subresource_range.aspectMask = subresource_layers.aspectMask;
193 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
194 subresource_range.layerCount = subresource_layers.layerCount;
195 subresource_range.baseMipLevel = subresource_layers.mipLevel;
196 subresource_range.levelCount = 1;
197 return subresource_range;
198}
199
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700200static VkImageLayout NormalizeImageLayout(VkImageLayout layout, VkImageLayout non_normal, VkImageLayout normal) {
201 return (layout == non_normal) ? normal : layout;
202}
203
204static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
205 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
206 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL);
207}
208
209static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
210 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
211 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL);
212}
213
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700214static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
215 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
216 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
217 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
218 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
219 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
220 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
221 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
222 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
223 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
224 }
225 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
226 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
227 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
228 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
229 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
230 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
231 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
232 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
233 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
234 }
235 }
236 return layout;
237}
238
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700239static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
240 bool matches = (a == b);
241 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700242 a = NormalizeSynchronization2Layout(aspect_mask, a);
243 b = NormalizeSynchronization2Layout(aspect_mask, b);
244 matches = (a == b);
245 if (!matches) {
246 // Relaxed rules when referencing *only* the depth or stencil aspects
247 if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
248 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
249 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
250 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
251 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700252 }
253 }
254 return matches;
255}
256
257// Utility type for ForRange callbacks
258struct LayoutUseCheckAndMessage {
259 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
260 const ImageSubresourceLayoutMap *layout_map;
261 const VkImageAspectFlags aspect_mask;
262 const char *message;
263 VkImageLayout layout;
264
265 LayoutUseCheckAndMessage() = delete;
266 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
267 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
268 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
269 message = nullptr;
270 layout = kInvalidLayout; // Success status
271 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
272 message = "previous known";
273 layout = current_layout;
274 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
275 // To check the relaxed rule matching we need to see how the initial use was used
276 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
277 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
278 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
279 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
280 message = "previously used";
281 layout = initial_layout;
282 }
283 }
284 return layout == kInvalidLayout;
285 }
286};
287
locke-lunarg540b2252020-08-03 13:23:36 -0600288bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600289 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600290 return true;
291 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600292 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600293 return false;
294 }
locke-lunarg540b2252020-08-03 13:23:36 -0600295 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
296 return false;
297 }
298
299 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600300 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600301 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600302 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600303 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600304 }
305
306 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600307 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600308 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600309 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600310 }
311
312 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600313 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600314 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600315 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600316 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600317 }
318
319 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600320 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600321 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600322 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600323 }
locke-lunargdc287022020-08-21 12:03:57 -0600324 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600325}
326
Dave Houltond9611312018-11-19 17:03:36 -0700327uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
328 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700329 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700330}
331
332uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
333
334uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
335
John Zulauf2d60a452021-03-04 15:12:03 -0700336bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600337 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state.image());
John Zulauf2076e812020-01-08 14:55:54 -0700338 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700339 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
340 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
341
John Zulauf2076e812020-01-08 14:55:54 -0700342 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
343
344 // 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 -0700345 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700346 return false;
347 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700348
John Zulauf79f06582021-02-27 18:38:39 -0700349 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700350 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700351 }
352 return true;
353}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700354
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600355// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600356void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600357 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
358 VkImageLayout expected_layout) {
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600359 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state);
John Zulauff660ad62019-03-23 07:16:05 -0600360 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600361 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600362 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700363 }
John Zulaufd13b38e2021-03-05 08:17:38 -0700364 for (const auto *alias_state : image_state.aliasing_images) {
365 assert(alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700366 // 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 -0600367 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700368 assert(subresource_map);
369 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
370 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700371}
John Zulauff660ad62019-03-23 07:16:05 -0600372
373// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600374void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600375 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500376 return;
377 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500378 IMAGE_STATE *image_state = view_state.image_state.get();
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600379 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700380 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulaufd13b38e2021-03-05 08:17:38 -0700381 for (const auto *alias_state : image_state->aliasing_images) {
382 assert(alias_state);
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600383 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700384 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
385 }
John Zulauff660ad62019-03-23 07:16:05 -0600386}
387
388// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600389void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600390 const VkImageSubresourceRange &range, VkImageLayout layout) {
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600391 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state);
John Zulauff660ad62019-03-23 07:16:05 -0600392 assert(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600393 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, image_state.NormalizeSubresourceRange(range), layout);
John Zulaufd13b38e2021-03-05 08:17:38 -0700394 for (const auto *alias_state : image_state.aliasing_images) {
395 assert(alias_state);
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600396 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700397 assert(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600398 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, alias_state->NormalizeSubresourceRange(range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700399 }
John Zulauff660ad62019-03-23 07:16:05 -0600400}
401
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600402void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600403 VkImageLayout layout) {
404 const IMAGE_STATE *image_state = GetImageState(image);
405 if (!image_state) return;
406 SetImageInitialLayout(cb_node, *image_state, range, layout);
407};
408
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600409void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600410 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
411 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600412}
Dave Houltonddd65c52018-05-08 14:58:01 -0600413
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600414// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700415void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
416 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500417 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600418
John Zulauff660ad62019-03-23 07:16:05 -0600419 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600420 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
421 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600422 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 -0600423 sub_range.baseArrayLayer = 0;
424 sub_range.layerCount = image_state->createInfo.extent.depth;
425 }
426
Piers Daniell4fde9b72019-11-27 16:19:46 -0700427 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
428 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
429 SetImageLayout(cb_node, *image_state, sub_range, layout);
430 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
431 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
432 } else {
433 SetImageLayout(cb_node, *image_state, sub_range, layout);
434 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600435}
436
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700437bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
438 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700439 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600440 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100441 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700442 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100443 const char *vuid;
444 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700445 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100446
447 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600448 LogObjectList objlist(image);
449 objlist.add(renderpass);
450 objlist.add(framebuffer);
451 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700452 skip |=
453 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
454 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
455 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
456 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100457 return skip;
458 }
459
460 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700461 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200462 if (stencil_usage_info) {
463 image_usage |= stencil_usage_info->stencilUsage;
464 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100465
466 // Check for layouts that mismatch image usages in the framebuffer
467 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800468 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
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 |= LogError(objlist, vuid,
474 "%s: Layout/usage mismatch for attachment %u in %s"
475 " - the %s is %s but the image attached to %s via %s"
476 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
477 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
478 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
479 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100480 }
481
482 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
483 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800484 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600485 LogObjectList objlist(image);
486 objlist.add(renderpass);
487 objlist.add(framebuffer);
488 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700489 skip |= LogError(objlist, vuid,
490 "%s: Layout/usage mismatch for attachment %u in %s"
491 " - the %s is %s but the image attached to %s via %s"
492 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
493 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
494 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
495 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100496 }
497
498 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800499 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600500 LogObjectList objlist(image);
501 objlist.add(renderpass);
502 objlist.add(framebuffer);
503 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700504 skip |= LogError(objlist, vuid,
505 "%s: Layout/usage mismatch for attachment %u in %s"
506 " - the %s is %s but the image attached to %s via %s"
507 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
508 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
509 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
510 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100511 }
512
513 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800514 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600515 LogObjectList objlist(image);
516 objlist.add(renderpass);
517 objlist.add(framebuffer);
518 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700519 skip |= LogError(objlist, vuid,
520 "%s: Layout/usage mismatch for attachment %u in %s"
521 " - the %s is %s but the image attached to %s via %s"
522 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
523 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
524 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
525 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100526 }
527
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600528 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100529 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
530 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
531 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
532 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
533 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800534 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600535 LogObjectList objlist(image);
536 objlist.add(renderpass);
537 objlist.add(framebuffer);
538 objlist.add(image_view);
539 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700540 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700541 " - the %s is %s but the image attached to %s via %s"
542 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700543 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700544 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
545 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100546 }
547 } else {
548 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
549 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
550 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
551 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600552 LogObjectList objlist(image);
553 objlist.add(renderpass);
554 objlist.add(framebuffer);
555 objlist.add(image_view);
556 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700557 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700558 " - the %s is %s but the image attached to %s via %s"
559 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700560 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700561 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
562 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100563 }
564 }
565 return skip;
566}
567
John Zulauf17a01bb2019-08-09 16:41:19 -0600568bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700569 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600570 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600571 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700572 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
573 auto const &framebuffer_info = framebuffer_state->createInfo;
574 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100575
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600576 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass();
577 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100578
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700579 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600580 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700581 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700582 }
John Zulauf8e308292018-09-21 11:34:37 -0600583
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700584 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800585 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700586 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100587 }
588
Tobias Hectorc9057422019-07-23 12:15:52 +0100589 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700590 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
591 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100592 auto image_view = attachments[i];
593 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100594
Tobias Hectorc9057422019-07-23 12:15:52 +0100595 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600596 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600597 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600598 objlist.add(image_view);
599 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700600 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600601 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700602 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100603 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100604 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100605
606 const VkImage image = view_state->create_info.image;
607 const IMAGE_STATE *image_state = GetImageState(image);
608
609 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600610 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600611 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600612 objlist.add(image_view);
613 objlist.add(image);
614 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700615 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600616 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700617 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100618 continue;
619 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700620 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
621 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100622
Piers Daniell7f894f62020-01-09 16:33:48 -0700623 // Default to expecting stencil in the same layout.
624 auto attachment_stencil_initial_layout = attachment_initial_layout;
625
626 // If a separate layout is specified, look for that.
627 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700628 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700629 if (attachment_description_stencil_layout) {
630 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
631 }
632
Tobias Hectorc9057422019-07-23 12:15:52 +0100633 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
634 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700635 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600636 ? const_p_cb->GetImageSubresourceLayoutMap(image)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700637 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100638
639 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
640 LayoutUseCheckAndMessage layout_check(subresource_map);
641 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700642 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700643 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
644 // the next "constant value" range
645 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700646 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700647
John Zulauf5e617452019-11-19 14:44:16 -0700648 // Allow for differing depth and stencil layouts
649 VkImageLayout check_layout = attachment_initial_layout;
650 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
651
652 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700653 subres_skip |= LogError(
654 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700655 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
656 "and the %s layout of the attachment is %s. The layouts must match, or the render "
657 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700658 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100659 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700660 }
John Zulauf5e617452019-11-19 14:44:16 -0700661
Tobias Hectorc9057422019-07-23 12:15:52 +0100662 skip |= subres_skip;
663 }
664
665 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
666 framebuffer, render_pass, i, "initial layout");
667
668 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
669 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100670 }
671
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700672 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
673 auto &subpass = render_pass_info->pSubpasses[j];
674 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100675 auto &attachment_ref = subpass.pInputAttachments[k];
676 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
677 auto image_view = attachments[attachment_ref.attachment];
678 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100679
Tobias Hectorc9057422019-07-23 12:15:52 +0100680 if (view_state) {
681 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700682 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
683 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100684 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100685 }
686 }
687 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100688
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700689 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100690 auto &attachment_ref = subpass.pColorAttachments[k];
691 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
692 auto image_view = attachments[attachment_ref.attachment];
693 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100694
Tobias Hectorc9057422019-07-23 12:15:52 +0100695 if (view_state) {
696 auto image = view_state->create_info.image;
697 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
698 framebuffer, render_pass, attachment_ref.attachment,
699 "color attachment layout");
700 if (subpass.pResolveAttachments) {
701 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
702 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
703 attachment_ref.attachment, "resolve attachment layout");
704 }
705 }
706 }
707 }
708
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700709 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100710 auto &attachment_ref = *subpass.pDepthStencilAttachment;
711 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
712 auto image_view = attachments[attachment_ref.attachment];
713 auto view_state = GetImageViewState(image_view);
714
715 if (view_state) {
716 auto image = view_state->create_info.image;
717 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
718 framebuffer, render_pass, attachment_ref.attachment,
719 "input attachment layout");
720 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100721 }
722 }
723 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700724 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600725 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700726}
727
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600728void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700729 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700730 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600731 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600732 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700733 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700734 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700735 if (attachment_reference_stencil_layout) {
736 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
737 }
738
739 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600740 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700741 }
742}
743
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600744void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
745 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700746 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700747
748 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700749 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700750 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700751 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700752 }
753 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700754 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700755 }
756 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700757 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700758 }
759 }
760}
761
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700762// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
763// 1. Transition into initialLayout state
764// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600765void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700766 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700767 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700768 auto const rpci = render_pass_state->createInfo.ptr();
769 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600770 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600771 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700772 IMAGE_STATE *image_state = view_state->image_state.get();
773 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700774 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700775 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700776 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700777 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
778 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
779 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
780 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
781 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
782 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
783 } else {
784 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700785 }
John Zulauf8e308292018-09-21 11:34:37 -0600786 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700787 }
788 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700789 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700790}
791
Dave Houlton10b39482017-03-16 13:18:15 -0600792bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600793 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600794 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600795 }
796 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600797 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600798 }
799 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600800 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600801 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800802 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 -0700803 if (FormatPlaneCount(format) == 1) return false;
804 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600805 return true;
806}
807
Mike Weiblen62d08a32017-03-07 22:18:27 -0700808// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700809bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700810 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700811 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700812 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700813 switch (layout) {
814 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700815 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700816 break;
817 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700818 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700819 break;
820 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700821 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700822 break;
823 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700824 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700825 break;
826 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700827 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700828 break;
829 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700830 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700831 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600832 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700833 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500834 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700835 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700836 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700837 break;
838 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700839 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700840 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700841 default:
842 // Other VkImageLayout values do not have VUs defined in this context.
843 break;
844 }
845
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700846 if (is_error) {
847 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
848
849 skip |=
850 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
851 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700852 }
853 return skip;
854}
855
856// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700857template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700858bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700859 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700860 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700861 using sync_vuid_maps::GetImageBarrierVUID;
862 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200863 // Scoreboard for checking for duplicate and inconsistent barriers to images
864 struct ImageBarrierScoreboardEntry {
865 uint32_t index;
866 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
867 // 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 -0700868 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +0200869 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700870 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
871 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
872 // when creating maps full of maps.
873 struct ImageBarrierScoreboardSubresMap {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700874 layer_data::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700875 };
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700876 using ImageBarrierScoreboardImageMap = layer_data::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
Petr Krausad0096a2019-08-09 18:35:04 +0200877
John Zulauf463c51e2018-05-31 13:29:20 -0600878 // Scoreboard for duplicate layout transition barriers within the list
879 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
880 ImageBarrierScoreboardImageMap layout_transitions;
881
Mike Weiblen62d08a32017-03-07 22:18:27 -0700882 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700883 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200884 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700885
John Zulauf463c51e2018-05-31 13:29:20 -0600886 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
887 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
888 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200889 if (img_barrier.oldLayout != img_barrier.newLayout) {
890 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
891 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600892 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700893 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +0200894 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600895 if (subres_it != subres_map.end()) {
896 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700897 auto entry_layout =
898 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
899 auto old_layout =
900 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
901 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200902 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700903 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700904 skip = LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600905 cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700906 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600907 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
908 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700909 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +0200910 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
911 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600912 }
913 entry = new_entry;
914 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200915 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600916 }
917 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700918 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600919 }
920 }
921
Petr Krausad0096a2019-08-09 18:35:04 +0200922 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600923 if (image_state) {
924 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700925 skip |=
926 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
927 skip |=
928 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600929
930 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
931 if (image_state->layout_locked) {
932 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700933 skip |= LogError(
934 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700935 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600936 " 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 -0700937 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
938 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600939 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600940
John Zulaufa4472282019-08-22 14:44:34 -0600941 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700942 const VkFormat image_format = image_create_info.format;
943 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600944 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700945 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700946 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700947 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600948 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700949 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
950 skip |= LogError(img_barrier.image, vuid,
951 "%s references %s of format %s that must have either the depth or stencil "
952 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
953 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
954 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600955 }
956 } else {
957 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
958 if ((aspect_mask & ds_mask) != (ds_mask)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700959 auto error = device_extensions.vk_khr_separate_depth_stencil_layouts
960 ? ImageError::kNotSeparateDepthAndStencilAspect
961 : ImageError::kNotDepthAndStencilAspect;
962 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700963 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700964 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700965 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700966 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700967 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600968 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700969 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700970 }
John Zulauff660ad62019-03-23 07:16:05 -0600971
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600972 const auto *subresource_map = cb_state->GetImageSubresourceLayoutMap(img_barrier.image);
Petr Krausad0096a2019-08-09 18:35:04 +0200973 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600974 // TODO: Set memory invalid which is in mem_tracker currently
975 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
976 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600977 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600978 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600979 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600980 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -0700981 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
982 // the next "constant value" range
983 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700984 const auto &value = *pos;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700985 auto old_layout =
986 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
987 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700988 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600989 subres_skip = LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700990 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
991 "%s layout is %s.",
992 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
993 value.subresource.aspectMask, value.subresource.mipLevel,
994 value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
995 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600996 }
John Zulauf5e617452019-11-19 14:44:16 -0700997 }
John Zulauff660ad62019-03-23 07:16:05 -0600998 skip |= subres_skip;
999 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001000
1001 // checks color format and (single-plane or non-disjoint)
1002 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1003 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001004 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001005 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001006 auto error = device_extensions.vk_khr_sampler_ycbcr_conversion ? ImageError::kNotColorAspect
1007 : ImageError::kNotColorAspectYcbcr;
1008 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -07001009 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001010 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -07001011 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001012 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001013 string_VkFormat(image_format), aspect_mask);
1014 }
1015 }
1016
1017 VkImageAspectFlags valid_disjoint_mask =
1018 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 -07001019 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001020 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001021 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1022 skip |= LogError(img_barrier.image, vuid,
1023 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -07001024 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001025 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001026 string_VkFormat(image_format), aspect_mask);
1027 }
1028
1029 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001030 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1031 skip |= LogError(img_barrier.image, vuid,
1032 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -07001033 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001034 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001035 string_VkFormat(image_format), aspect_mask);
1036 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001037 }
1038 }
1039 return skip;
1040}
1041
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001042template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001043bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001044 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001045 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001046 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001047 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001048 if (!IsTransferOp(barrier)) {
1049 return skip;
1050 }
1051 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebbenefead332021-06-18 08:22:44 -06001052 if (cb_state->IsReleaseOp<Barrier, true /* Assume IsTransfer */>(barrier) &&
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001053 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1054 const auto found = barrier_sets.release.find(barrier);
1055 if (found != barrier_sets.release.cend()) {
1056 barrier_record = &(*found);
1057 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001058 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06001059 } else if (cb_state->IsAcquireOp<Barrier, true /*Assume IsTransfer */>(barrier) &&
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001060 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1061 const auto found = barrier_sets.acquire.find(barrier);
1062 if (found != barrier_sets.acquire.cend()) {
1063 barrier_record = &(*found);
1064 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001065 }
1066 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001067 if (barrier_record != nullptr) {
1068 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001069 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001070 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1071 " duplicates existing barrier recorded in this command buffer.",
1072 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1073 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1074 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001075 return skip;
1076}
1077
John Zulaufa4472282019-08-22 14:44:34 -06001078VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1079 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1080}
1081
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001082VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1083 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1084}
1085
John Zulaufa4472282019-08-22 14:44:34 -06001086const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1087 return device_state.GetImageState(barrier.image);
1088}
1089
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001090const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1091 return device_state.GetImageState(barrier.image);
1092}
1093
John Zulaufa4472282019-08-22 14:44:34 -06001094VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1095 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1096}
1097
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001098VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1099 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1100}
1101
John Zulaufa4472282019-08-22 14:44:34 -06001102const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1103 return device_state.GetBufferState(barrier.buffer);
1104}
1105
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001106const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1107 return device_state.GetBufferState(barrier.buffer);
1108}
John Zulaufa4472282019-08-22 14:44:34 -06001109
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001110template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001111void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001112 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001113 if (IsTransferOp(barrier)) {
Jeremy Gebbenefead332021-06-18 08:22:44 -06001114 if (cb_state->IsReleaseOp<Barrier, true /* Assume IsTransfer*/>(barrier) &&
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001115 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1116 barrier_sets.release.emplace(barrier);
Jeremy Gebbenefead332021-06-18 08:22:44 -06001117 } else if (cb_state->IsAcquireOp<Barrier, true /*Assume IsTransfer */>(barrier) &&
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001118 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1119 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001120 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001121 }
John Zulaufa4472282019-08-22 14:44:34 -06001122
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001123 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1124 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001125 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1126 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001127 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1128
1129 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001130 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1131 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1132 auto handle_state = BarrierHandleState(*this, barrier);
1133 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1134 if (!mode_concurrent) {
1135 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001136 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001137 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001138 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1139 const QUEUE_STATE *queue_state) {
1140 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001141 src_queue_family, dst_queue_family);
1142 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001143 }
1144 }
1145}
1146
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001147// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001148template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001149bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001150 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1151 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001152 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1153 using sync_vuid_maps::GetImageBarrierVUID;
1154 using sync_vuid_maps::ImageError;
1155
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001156 bool skip = false;
1157 const auto *fb_state = framebuffer;
1158 assert(fb_state);
1159 const auto img_bar_image = img_barrier.image;
1160 bool image_match = false;
1161 bool sub_image_found = false; // Do we find a corresponding subpass description
1162 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1163 uint32_t attach_index = 0;
1164 // Verify that a framebuffer image matches barrier image
1165 const auto attachment_count = fb_state->createInfo.attachmentCount;
1166 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001167 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001168 if (view_state && (img_bar_image == view_state->create_info.image)) {
1169 image_match = true;
1170 attach_index = attachment;
1171 break;
1172 }
1173 }
1174 if (image_match) { // Make sure subpass is referring to matching attachment
1175 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1176 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1177 sub_image_found = true;
1178 }
1179 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1180 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1181 if (resolve && resolve->pDepthStencilResolveAttachment &&
1182 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1183 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1184 sub_image_found = true;
1185 }
1186 }
1187 if (!sub_image_found) {
1188 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1189 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1190 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1191 sub_image_found = true;
1192 break;
1193 }
1194 if (!sub_image_found && sub_desc.pResolveAttachments &&
1195 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1196 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1197 sub_image_found = true;
1198 break;
1199 }
1200 }
1201 }
1202 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001203 auto img_loc = loc.dot(Field::image);
1204 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1205 skip |=
1206 LogError(rp_handle, vuid,
1207 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1208 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1209 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001210 }
1211 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 auto img_loc = loc.dot(Field::image);
1213 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001214 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 -07001215 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001216 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001217 }
1218 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001219 auto layout_loc = loc.dot(Field::oldLayout);
1220 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001221 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001222 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001223 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001224 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001225 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1226 } else {
1227 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1228 LogObjectList objlist(rp_handle);
1229 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001230 auto layout_loc = loc.dot(Field::oldLayout);
1231 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1232 skip |= LogError(objlist, vuid,
1233 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001234 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001235 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001236 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1237 string_VkImageLayout(img_barrier.oldLayout));
1238 }
1239 }
1240 return skip;
1241}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001242// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001243template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001244 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1245 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1246 const VkImageMemoryBarrier &img_barrier,
1247 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001248template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001249 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1250 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1251 const VkImageMemoryBarrier2KHR &img_barrier,
1252 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001253
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001254template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001255void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001256 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001257 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1258 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1259 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1260 const auto active_subpass = cb_state->activeSubpass;
1261 const auto rp_state = cb_state->activeRenderPass;
1262 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001263 // Secondary CB case w/o FB specified delay validation
1264 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001265 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001266 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001267 cb_state->cmd_execute_commands_functions.emplace_back(
1268 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1269 const FRAMEBUFFER_STATE *fb) {
1270 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1271 render_pass, barrier, primary_cb);
1272 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001273 }
1274}
1275
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001276void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001277 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1278 const VkImageMemoryBarrier *pImageMemBarriers) {
1279 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001280 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001281 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1282 }
1283 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001284 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001285 const auto &img_barrier = pImageMemBarriers[i];
1286 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1287 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1288 }
1289}
1290
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001291void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001292 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001293 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001294 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1295 }
1296 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001297 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001298 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1299 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1300 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1301 }
1302}
1303
1304template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001305bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001306 const char *operation, const TransferBarrier &barrier,
1307 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001308 // Record to the scoreboard or report that we have a duplication
1309 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001310 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001311 if (!inserted.second && inserted.first->second != cb_state) {
1312 // 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 -06001313 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001314 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001315 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001316 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001317 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1318 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001319 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001320 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001321 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001322 }
1323 return skip;
1324}
1325
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001326template <typename TransferBarrier>
1327bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1328 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1329 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001330 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001331 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001332 const char *barrier_name = TransferBarrier::BarrierName();
1333 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001334 // No release should have an extant duplicate (WARNING)
1335 for (const auto &release : cb_barriers.release) {
1336 // Check the global pending release barriers
1337 const auto set_it = global_release_barriers.find(release.handle);
1338 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001339 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001340 const auto found = set_for_handle.find(release);
1341 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001342 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001343 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1344 " to dstQueueFamilyIndex %" PRIu32
1345 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1346 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1347 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001348 }
1349 }
1350 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1351 }
1352 // Each acquire must have a matching release (ERROR)
1353 for (const auto &acquire : cb_barriers.acquire) {
1354 const auto set_it = global_release_barriers.find(acquire.handle);
1355 bool matching_release_found = false;
1356 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001357 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001358 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1359 }
1360 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001361 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001362 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1363 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1364 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1365 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001366 }
1367 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1368 }
1369 return skip;
1370}
1371
John Zulauf3b04ebd2019-07-18 14:08:11 -06001372bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001373 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1374 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001375 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001376 skip |=
1377 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1378 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1379 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001380 return skip;
1381}
1382
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001383template <typename TransferBarrier>
1384void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1385 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001386 // Add release barriers from this submit to the global map
1387 for (const auto &release : cb_barriers.release) {
1388 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1389 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1390 global_release_barriers[release.handle].insert(release);
1391 }
1392
1393 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1394 for (const auto &acquire : cb_barriers.acquire) {
1395 // NOTE: We're not using [] because we don't want to create entries for missing releases
1396 auto set_it = global_release_barriers.find(acquire.handle);
1397 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001398 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001399 set_for_handle.erase(acquire);
1400 if (set_for_handle.size() == 0) { // Clean up empty sets
1401 global_release_barriers.erase(set_it);
1402 }
1403 }
1404 }
1405}
1406
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001407void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001408 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1409 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1410 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001411}
1412
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001413template <typename ImgBarrier>
1414void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1415 // For ownership transfers, the barrier is specified twice; as a release
1416 // operation on the yielding queue family, and as an acquire operation
1417 // on the acquiring queue family. This barrier may also include a layout
1418 // transition, which occurs 'between' the two operations. For validation
1419 // purposes it doesn't seem important which side performs the layout
1420 // transition, but it must not be performed twice. We'll arbitrarily
1421 // choose to perform it as part of the acquire operation.
1422 //
1423 // However, we still need to record initial layout for the "initial layout" validation
1424 for (uint32_t i = 0; i < barrier_count; i++) {
1425 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001426 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001427 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001428 if (image_state) {
1429 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1430 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001431 }
1432}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001433// explictly instantiate this template so it can be used in core_validation.cpp
1434template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1435 const VkImageMemoryBarrier *barrier);
1436template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1437 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001438
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001439VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1440
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001441template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001442void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001443 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001444 if (enabled_features.synchronization2_features.synchronization2) {
1445 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1446 return;
1447 }
1448 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001449 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001450 const auto &image_create_info = image_state->createInfo;
1451
Mike Schuchardt2df08912020-12-15 16:28:09 -08001452 // 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 -07001453 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001454 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001455 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001456 normalized_isr.baseArrayLayer = 0;
1457 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1458 }
1459
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001460 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1461 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001462
1463 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001464 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001465 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1466 }
1467
John Zulauf2be3fe02019-12-30 09:48:02 -07001468 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001469 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001470 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001471 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001472 }
unknown86bcb3a2019-07-11 13:05:36 -06001473}
1474
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001475bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1476 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1477 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1478 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001479 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001480 assert(cb_node);
1481 assert(image_state);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001482 const auto image = image_state->image();
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001483 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001484
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001485 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image);
John Zulauff660ad62019-03-23 07:16:05 -06001486 if (subresource_map) {
1487 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001488 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001489 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1490 // the next "constant value" range
1491 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001492 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001493 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001494 subres_skip |= LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001495 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1496 "%s layout %s.",
1497 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1498 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1499 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001500 }
John Zulauf5e617452019-11-19 14:44:16 -07001501 }
John Zulauff660ad62019-03-23 07:16:05 -06001502 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001503 }
John Zulauff660ad62019-03-23 07:16:05 -06001504
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001505 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1506 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1507 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001508 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1509 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001510 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001511 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1512 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001513 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001514 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001515 if (image_state->shared_presentable) {
1516 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001517 skip |=
1518 LogError(device, layout_invalid_msg_code,
1519 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1520 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001521 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001522 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001523 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001524 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001525 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001526 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1527 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1528 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001529 }
1530 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001531 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001532}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001533bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001534 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1535 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001536 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001537 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1538 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1539}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001540
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001541void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001542 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001543 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1544 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001545
Mike Schuchardt2df08912020-12-15 16:28:09 -08001546 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001547 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001548 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001549 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001550 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001551 VkImageLayout stencil_layout = kInvalidLayout;
1552 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001553 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001554 if (attachment_description_stencil_layout) {
1555 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1556 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001557 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001558 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001559 }
1560 }
1561}
Dave Houltone19e20d2018-02-02 16:32:41 -07001562
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001563#ifdef VK_USE_PLATFORM_ANDROID_KHR
1564// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1565// This could also move into a seperate core_validation_android.cpp file... ?
1566
1567//
1568// AHB-specific validation within non-AHB APIs
1569//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001570bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001571 bool skip = false;
1572
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001573 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001574 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001575 if (0 != ext_fmt_android->externalFormat) {
1576 if (VK_FORMAT_UNDEFINED != create_info->format) {
1577 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001578 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1579 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1580 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001581 }
1582
1583 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001584 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1585 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1586 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001587 }
1588
1589 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001590 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1591 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001592 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001593 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001594 }
1595
1596 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001597 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1598 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1599 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001600 }
1601 }
1602
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001603 if ((0 != ext_fmt_android->externalFormat) &&
1604 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001605 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001606 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1607 ") which has "
1608 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1609 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001610 }
1611 }
1612
Dave Houltond9611312018-11-19 17:03:36 -07001613 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001614 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001615 skip |=
1616 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1617 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1618 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001619 }
1620 }
1621
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001622 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001623 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1624 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001625 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001626 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1627 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1628 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1629 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001630 }
1631
1632 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001633 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1634 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1635 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1636 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1637 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001638 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001639 }
1640
1641 return skip;
1642}
1643
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001644bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001645 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001646 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001647
1648 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001649 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001650 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1651 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001652 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001653 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001654 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001655
Dave Houltond9611312018-11-19 17:03:36 -07001656 // Chain must include a compatible ycbcr conversion
1657 bool conv_found = false;
1658 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001659 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001660 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001661 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001662 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001663 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001664 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001665 }
Dave Houltond9611312018-11-19 17:03:36 -07001666 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001667 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001668 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001669 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1670 "an externalFormat (%" PRIu64
1671 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1672 "with the same external format.",
1673 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001674 }
1675
1676 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001677 if (IsIdentitySwizzle(create_info->components) == false) {
1678 skip |= LogError(
1679 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1680 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1681 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1682 "= %s.",
1683 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1684 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001685 }
1686 }
Dave Houltond9611312018-11-19 17:03:36 -07001687
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001688 return skip;
1689}
1690
John Zulaufa26d3c82019-08-14 16:09:08 -06001691bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001692 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001693
John Zulaufa26d3c82019-08-14 16:09:08 -06001694 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001695 if (image_state != nullptr) {
1696 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1697 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1698 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1699 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1700 "bound to memory.");
1701 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001702 }
1703 return skip;
1704}
1705
1706#else
1707
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001708bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001709 return false;
1710}
1711
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001712bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001713
John Zulaufa26d3c82019-08-14 16:09:08 -06001714bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001715
1716#endif // VK_USE_PLATFORM_ANDROID_KHR
1717
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001718bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1719 bool skip = false;
1720
1721 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1722 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1723 const VkImageTiling image_tiling = pCreateInfo->tiling;
1724 const VkFormat image_format = pCreateInfo->format;
1725
1726 if (image_format == VK_FORMAT_UNDEFINED) {
1727 // VU 01975 states format can't be undefined unless an android externalFormat
1728#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001729 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001730 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1731 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1732 if (it != ahb_ext_formats_map.end()) {
1733 tiling_features = it->second;
1734 }
1735 }
1736#endif
1737 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1738 uint64_t drm_format_modifier = 0;
1739 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001740 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001741 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001742 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001743
1744 if (drm_explicit != nullptr) {
1745 drm_format_modifier = drm_explicit->drmFormatModifier;
1746 } else {
1747 // VUID 02261 makes sure its only explict or implict in parameter checking
1748 assert(drm_implicit != nullptr);
1749 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1750 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1751 }
1752 }
1753
1754 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1755 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1756 nullptr};
1757 format_properties_2.pNext = (void *)&drm_properties_list;
1758 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001759 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1760 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1761 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1762 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001763
1764 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1765 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1766 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1767 }
1768 }
1769 } else {
1770 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1771 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1772 : format_properties.optimalTilingFeatures;
1773 }
1774
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001775 // Lack of disjoint format feature support while using the flag
1776 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1777 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1778 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1779 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1780 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1781 string_VkFormat(pCreateInfo->format));
1782 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001783
1784 return skip;
1785}
1786
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001787bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001788 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001789 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001790
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001791 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001792 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001793 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1794 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001795 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1796 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001797 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001798 }
1799
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001800 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1801 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001802 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1803 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1804 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001805 }
1806
1807 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001808 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1809 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1810 "height (%d) and arrayLayers (%d) must be >= 6.",
1811 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001812 }
Dave Houlton130c0212018-01-29 13:39:56 -07001813 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001814
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001815 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001816 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1817 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1818 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001819 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001820 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1821 "device maxFramebufferWidth (%u).",
1822 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001823 }
1824
1825 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001826 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001827 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1828 "device maxFramebufferHeight (%u).",
1829 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001830 }
1831
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001832 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001833 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1834 static_cast<float>(device_limits->maxFramebufferWidth) /
1835 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001836 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1837 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001838 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1839 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1840 "ceiling of device "
1841 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1842 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1843 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001844 }
1845
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001846 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1847 static_cast<float>(device_limits->maxFramebufferHeight) /
1848 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001849 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1850 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001851 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1852 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1853 "ceiling of device "
1854 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1855 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1856 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001857 }
1858 }
1859
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001860 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001861 VkResult result = VK_SUCCESS;
1862 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1863 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1864 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1865 &format_limits);
1866 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001867 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1868 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001869 if (modifier_list) {
1870 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001871 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001872 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001873 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001874 image_format_info.type = pCreateInfo->imageType;
1875 image_format_info.format = pCreateInfo->format;
1876 image_format_info.tiling = pCreateInfo->tiling;
1877 image_format_info.usage = pCreateInfo->usage;
1878 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001879 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001880
1881 result =
1882 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1883 format_limits = image_format_properties.imageFormatProperties;
1884
1885 /* The application gives a list of modifier and the driver
1886 * selects one. If one is wrong, stop there.
1887 */
1888 if (result != VK_SUCCESS) break;
1889 }
1890 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001891 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001892 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001893 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001894 image_format_info.type = pCreateInfo->imageType;
1895 image_format_info.format = pCreateInfo->format;
1896 image_format_info.tiling = pCreateInfo->tiling;
1897 image_format_info.usage = pCreateInfo->usage;
1898 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001899 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001900
1901 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1902 format_limits = image_format_properties.imageFormatProperties;
1903 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001904 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001905
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001906 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1907 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1908 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1909 if (result != VK_SUCCESS) {
1910 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001911#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001912 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001913#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001914 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001915 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001916 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1917 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001918#ifdef VK_USE_PLATFORM_ANDROID_KHR
1919 }
1920#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001921 } else {
1922 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1923 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001924 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1925 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1926 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001927 }
Dave Houlton130c0212018-01-29 13:39:56 -07001928
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001929 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1930 static_cast<uint64_t>(pCreateInfo->extent.height) *
1931 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1932 static_cast<uint64_t>(pCreateInfo->samples);
1933 uint64_t total_size =
1934 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07001935
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001936 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001937 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1938 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001939 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001940
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001941 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001942 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1943 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1944 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1945 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001946 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001947
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001948 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001949 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1950 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1951 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001952 }
1953
1954 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001955 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1956 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1957 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001958 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001959
1960 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1961 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1962 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1963 pCreateInfo->extent.width, format_limits.maxExtent.width);
1964 }
1965
1966 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1967 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1968 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1969 pCreateInfo->extent.height, format_limits.maxExtent.height);
1970 }
1971
1972 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1973 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1974 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1975 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1976 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001977 }
1978
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001979 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001980 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1981 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1982 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1983 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001984 skip |= LogError(device, error_vuid,
1985 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1986 "YCbCr Conversion format, arrayLayers must be 1",
1987 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001988 }
1989
1990 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001991 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1992 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1993 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001994 }
1995
1996 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001997 skip |= LogError(
1998 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001999 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2000 string_VkSampleCountFlagBits(pCreateInfo->samples));
2001 }
2002
2003 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002004 skip |= LogError(
2005 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002006 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2007 string_VkImageType(pCreateInfo->imageType));
2008 }
2009 }
2010
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002011 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002012 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002013 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002014 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002015 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2016 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2017 "format must be block, ETC or ASTC compressed, but is %s",
2018 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002019 }
2020 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002021 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2022 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2023 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002024 }
2025 }
2026 }
2027
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002028 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002029 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2030 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2031 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002032 }
2033
unknown2c877272019-07-11 12:56:50 -06002034 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2035 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2036 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002037 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2038 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2039 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002040 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002041
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002042 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002043 if (swapchain_create_info != nullptr) {
2044 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2045 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2046 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2047
2048 // Validate rest of Swapchain Image create check that require swapchain state
2049 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2050 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2051 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2052 skip |= LogError(
2053 device, vuid,
2054 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2055 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2056 }
2057 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2058 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2059 skip |= LogError(device, vuid,
2060 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2061 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2062 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002063 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002064 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2065 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2066 skip |= LogError(device, vuid,
2067 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2068 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002069 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002070 }
2071 }
2072 }
2073
sfricke-samsungedce77a2020-07-03 22:35:13 -07002074 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2075 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2076 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2077 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2078 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2079 }
2080 const VkImageCreateFlags invalid_flags =
2081 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2082 if ((pCreateInfo->flags & invalid_flags) != 0) {
2083 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2084 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2085 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2086 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2087 }
2088 }
2089
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002090 skip |= ValidateImageFormatFeatures(pCreateInfo);
2091
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002092 // Check compatibility with VK_KHR_portability_subset
2093 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2094 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2095 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2096 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2097 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2098 }
2099 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2100 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2101 skip |=
2102 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2103 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2104 }
2105 }
2106
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002107 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002108}
2109
John Zulauf7eeb6f72019-06-17 11:56:36 -06002110void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2111 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2112 if (VK_SUCCESS != result) return;
2113
2114 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002115 auto image_state = Get<IMAGE_STATE>(*pImage);
2116 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002117}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002118
Jeff Bolz5c801d12019-10-09 10:38:45 -05002119bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002120 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002121 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002122 if (image_state) {
sfricke-samsung9056cc12021-04-18 22:51:00 -07002123 if (image_state->is_swapchain_image) {
2124 // TODO - Add VUID when headers are upstreamed
2125 skip |= LogError(device, "UNASSIGNED-vkDestroyImage-image",
2126 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2127 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002128 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002129 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002130 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002131 }
2132 return skip;
2133}
2134
John Zulauf7eeb6f72019-06-17 11:56:36 -06002135void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2136 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002137 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002138
locke-lunargcba7d5f2019-12-30 16:59:11 -07002139 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002140
2141 // Clean up generic image state
2142 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002143}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002144
sfricke-samsungcd924d92020-05-20 23:51:17 -07002145bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2146 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002147 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002148 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002149 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002150
2151 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002152 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2153 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002154 }
2155
sfricke-samsungcd924d92020-05-20 23:51:17 -07002156 if (FormatIsDepthOrStencil(format)) {
2157 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2158 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2159 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2160 } else if (FormatIsCompressed(format)) {
2161 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2162 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2163 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002164 }
2165
2166 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002167 skip |=
2168 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2169 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2170 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002171 }
2172 return skip;
2173}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002174
John Zulauf07288512019-07-05 11:09:50 -06002175bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2176 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2177 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002178 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002179 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2180 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002181 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002182 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2183 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002184 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002185
2186 } else {
2187 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2188 if (!device_extensions.vk_khr_shared_presentable_image) {
2189 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002190 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002191 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2192 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002193 }
2194 } else {
2195 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2196 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002197 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002198 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002199 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2200 func_name, string_VkImageLayout(dest_image_layout));
2201 }
2202 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002203 }
2204
John Zulauff660ad62019-03-23 07:16:05 -06002205 // Cast to const to prevent creation at validate time.
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002206 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state->image());
John Zulauff660ad62019-03-23 07:16:05 -06002207 if (subresource_map) {
2208 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002209 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002210 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002211 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2212 // the next "constant value" range
2213 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002214 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002215 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2216 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2217 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2218 } else {
2219 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002220 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002221 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002222 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2223 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2224 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002225 }
John Zulauf5e617452019-11-19 14:44:16 -07002226 }
John Zulauff660ad62019-03-23 07:16:05 -06002227 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002228 }
2229
2230 return skip;
2231}
2232
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002233bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2234 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002235 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002236 bool skip = false;
2237 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002238 const auto *cb_node = GetCBState(commandBuffer);
2239 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002240 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002241 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002242 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002243 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002244 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2245 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002246 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002247 skip |=
2248 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2249 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2250 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002251 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002252 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002253 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002254 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002255 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002256 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002257 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2258 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2259 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2260 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2261 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2262 string_VkFormat(image_state->createInfo.format));
2263 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002264 }
2265 return skip;
2266}
2267
John Zulaufeabb4462019-07-05 14:13:03 -06002268void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2269 const VkClearColorValue *pColor, uint32_t rangeCount,
2270 const VkImageSubresourceRange *pRanges) {
2271 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2272
2273 auto cb_node = GetCBState(commandBuffer);
2274 auto image_state = GetImageState(image);
2275 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002276 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002277 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002278 }
2279 }
2280}
2281
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002282bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2283 const char *apiName) const {
2284 bool skip = false;
2285
2286 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2287 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2288 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2289 // Also VUID-VkClearDepthStencilValue-depth-00022
2290 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2291 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2292 "(=%f) is not within the [0.0, 1.0] range.",
2293 apiName, clearValue.depth);
2294 }
2295 }
2296
2297 return skip;
2298}
2299
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002300bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2301 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002302 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002303 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002304
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002305 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002306 const auto *cb_node = GetCBState(commandBuffer);
2307 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002308 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002309 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002310 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002311 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002312 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002313 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002314 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002315 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002316 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002317 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002318 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2319 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2320 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2321 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002322
2323 bool any_include_aspect_depth_bit = false;
2324 bool any_include_aspect_stencil_bit = false;
2325
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002326 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002327 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002328 skip |= ValidateCmdClearDepthSubresourceRange(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, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002330 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002331 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2332 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002333 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2334 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2335 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2336 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002337 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002338 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2339 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002340 if (FormatHasDepth(image_format) == false) {
2341 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2342 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2343 "doesn't have a depth component.",
2344 i, string_VkFormat(image_format));
2345 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002346 }
2347 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2348 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002349 if (FormatHasStencil(image_format) == false) {
2350 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2351 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2352 "%s doesn't have a stencil component.",
2353 i, string_VkFormat(image_format));
2354 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002355 }
2356 }
2357 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002358 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002359 if (image_stencil_struct != nullptr) {
2360 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2361 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002362 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2363 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2364 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2365 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002366 }
2367 } else {
2368 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002369 skip |= LogError(
2370 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002371 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2372 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2373 "in VkImageCreateInfo::usage used to create image");
2374 }
2375 }
2376 }
2377 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002378 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2379 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2380 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002381 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002382 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002383 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2384 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002385 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002386 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002387 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002388 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2389 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2390 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2391 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002392 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002393 }
2394 return skip;
2395}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002396
John Zulaufeabb4462019-07-05 14:13:03 -06002397void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2398 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2399 const VkImageSubresourceRange *pRanges) {
2400 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2401 auto cb_node = GetCBState(commandBuffer);
2402 auto image_state = GetImageState(image);
2403 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002404 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002405 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002406 }
2407 }
2408}
2409
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002410// Returns true if [x, xoffset] and [y, yoffset] overlap
2411static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2412 bool result = false;
2413 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2414 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2415
2416 if (intersection_max > intersection_min) {
2417 result = true;
2418 }
2419 return result;
2420}
2421
Jeff Leger178b1e52020-10-05 12:22:23 -04002422// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002423// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002424template <typename RegionType>
2425static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002426 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002427
Dave Houltonc991cc92018-03-06 11:08:51 -07002428 // Separate planes within a multiplane image cannot intersect
2429 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002430 return result;
2431 }
2432
Dave Houltonc991cc92018-03-06 11:08:51 -07002433 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2434 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2435 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002436 result = true;
2437 switch (type) {
2438 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002439 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002440 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002441 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002442 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002443 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002444 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002445 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002446 break;
2447 default:
2448 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2449 assert(false);
2450 }
2451 }
2452 return result;
2453}
2454
Dave Houltonfc1a4052017-04-27 14:32:45 -06002455// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002456static const uint32_t kXBit = 1;
2457static const uint32_t kYBit = 2;
2458static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002459static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002460 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002461 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002462 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2463 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002464 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002465 }
2466 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2467 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002468 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002469 }
2470 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2471 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002472 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002473 }
2474 return result;
2475}
2476
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002477// Test if two VkExtent3D structs are equivalent
2478static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2479 bool result = true;
2480 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2481 (extent->depth != other_extent->depth)) {
2482 result = false;
2483 }
2484 return result;
2485}
2486
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002487// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002488static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002489 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2490}
2491
2492// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002493VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002494 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2495 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002496 auto pool = cb_node->command_pool.get();
2497 if (pool) {
2498 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002499 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002500 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002501 granularity.width *= block_size.width;
2502 granularity.height *= block_size.height;
2503 }
2504 }
2505 return granularity;
2506}
2507
2508// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2509static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2510 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002511 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2512 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002513 valid = false;
2514 }
2515 return valid;
2516}
2517
2518// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002519bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002520 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002521 bool skip = false;
2522 VkExtent3D offset_extent = {};
2523 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2524 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2525 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002526 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002527 // 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 -07002528 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002529 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002530 "%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 "
2531 "image transfer granularity is (w=0, h=0, d=0).",
2532 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002533 }
2534 } else {
2535 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2536 // integer multiples of the image transfer granularity.
2537 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002538 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002539 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2540 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2541 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2542 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002543 }
2544 }
2545 return skip;
2546}
2547
2548// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002549bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002550 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002551 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002552 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002553 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002554 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2555 // subresource extent.
2556 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002557 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002558 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2559 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2560 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2561 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002562 }
2563 } else {
2564 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2565 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2566 // subresource extent dimensions.
2567 VkExtent3D offset_extent_sum = {};
2568 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2569 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2570 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002571 bool x_ok = true;
2572 bool y_ok = true;
2573 bool z_ok = true;
2574 switch (image_type) {
2575 case VK_IMAGE_TYPE_3D:
2576 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2577 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002578 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002579 case VK_IMAGE_TYPE_2D:
2580 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2581 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002582 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002583 case VK_IMAGE_TYPE_1D:
2584 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2585 (subresource_extent->width == offset_extent_sum.width));
2586 break;
2587 default:
2588 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2589 assert(false);
2590 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002591 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002592 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002593 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002594 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2595 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2596 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2597 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2598 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2599 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002600 }
2601 }
2602 return skip;
2603}
2604
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002605bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002606 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002607 bool skip = false;
2608 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002609 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2610 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002611 }
2612 return skip;
2613}
2614
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002615bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002616 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002617 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002618 bool skip = false;
2619 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2620 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002621 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002622 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2623 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002624 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002625 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002626 }
2627 return skip;
2628}
2629
Jeff Leger178b1e52020-10-05 12:22:23 -04002630// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2631template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002632bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002633 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002634 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002635 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002636 VkExtent3D granularity = GetScaledItg(cb_node, img);
2637 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002638 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002639 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002640 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002641 return skip;
2642}
2643
Jeff Leger178b1e52020-10-05 12:22:23 -04002644// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2645template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002646bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002647 const IMAGE_STATE *dst_img, const RegionType *region,
2648 const uint32_t i, const char *function,
2649 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002650 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002651 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2652 const char *vuid;
2653
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002654 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002655 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002656 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2657 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002658 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002659 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002660 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002661 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002662 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002663
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002664 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002665 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002666 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2667 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002668 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002669 const VkExtent3D dest_effective_extent =
2670 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002671 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002672 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002673 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002674 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002675 return skip;
2676}
2677
Jeff Leger178b1e52020-10-05 12:22:23 -04002678// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2679template <typename ImageCopyRegionType>
2680bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2681 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2682 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002683 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002684 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2685 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2686 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002687
2688 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002689 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002690
2691 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002692 const VkExtent3D src_copy_extent = region.extent;
2693 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002694 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2695
Dave Houlton6f9059e2017-05-02 17:15:13 -06002696 bool slice_override = false;
2697 uint32_t depth_slices = 0;
2698
2699 // Special case for copying between a 1D/2D array and a 3D image
2700 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2701 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002702 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002703 slice_override = (depth_slices != 1);
2704 } 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 -07002705 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002706 slice_override = (depth_slices != 1);
2707 }
2708
2709 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002710 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002711 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002712 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002713 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002714 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2715 "be 0 and 1, respectively.",
2716 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002717 }
2718 }
2719
Dave Houlton533be9f2018-03-26 17:08:30 -06002720 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 -04002721 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002722 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002723 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002724 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002725 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 }
2727
Dave Houlton533be9f2018-03-26 17:08:30 -06002728 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002729 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002730 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 -04002731 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002732 }
2733
Dave Houltonc991cc92018-03-06 11:08:51 -07002734 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002735 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002736 if (FormatIsCompressed(src_state->createInfo.format) ||
2737 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002738 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002739 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002740 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2741 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2742 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002743 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002744 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002745 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002746 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002747 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002748 }
2749
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002750 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002751 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2752 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002753 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002754 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002755 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2756 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2757 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002758 }
2759
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002760 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002761 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2762 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002763 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002764 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002765 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2766 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2767 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002768 }
2769
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002770 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002771 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2772 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002774 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002775 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2776 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2777 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002778 }
2779 } // Compressed
2780
2781 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002782 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002783 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002784 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002785 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002786 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002787 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002788 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002789 }
2790 }
2791
Dave Houlton533be9f2018-03-26 17:08:30 -06002792 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 -04002793 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002794 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002795 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2796 "and 1, respectively.",
2797 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002798 }
2799
Dave Houlton533be9f2018-03-26 17:08:30 -06002800 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002801 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002802 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 -04002803 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002804 }
2805
sfricke-samsung30b094c2020-05-30 11:42:11 -07002806 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002807 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002808 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2809 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002810 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002811 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002812 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2813 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2814 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002815 }
2816 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002817 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002818 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002819 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002820 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2822 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2823 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002824 }
2825 }
2826 } else { // Pre maint 1
2827 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002828 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002829 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002830 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002831 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002832 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2833 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002834 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002835 }
Dave Houltonee281a52017-12-08 13:51:02 -07002836 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002837 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002838 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002839 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002840 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2841 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002842 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002843 }
2844 }
2845 }
2846
Dave Houltonc991cc92018-03-06 11:08:51 -07002847 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2848 if (FormatIsCompressed(dst_state->createInfo.format) ||
2849 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002850 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002851
2852 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002853 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2854 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2855 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002856 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002857 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002858 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002859 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002861 }
2862
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002863 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002864 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2865 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002866 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002867 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002868 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2869 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2870 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002871 }
2872
Dave Houltonee281a52017-12-08 13:51:02 -07002873 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2874 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2875 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002876 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002877 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002878 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002879 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2880 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002881 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002882 }
2883
Dave Houltonee281a52017-12-08 13:51:02 -07002884 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2885 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2886 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002887 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002888 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002889 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2890 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2891 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002892 }
2893 } // Compressed
2894 }
2895 return skip;
2896}
2897
Jeff Leger178b1e52020-10-05 12:22:23 -04002898template <typename RegionType>
2899bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2900 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2901 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002902 const auto *cb_node = GetCBState(commandBuffer);
2903 const auto *src_image_state = GetImageState(srcImage);
2904 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002905 const VkFormat src_format = src_image_state->createInfo.format;
2906 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002907 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002908 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002909
Jeff Leger178b1e52020-10-05 12:22:23 -04002910 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2911 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2912 const char *vuid;
2913
2914 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002915
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002916 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002917
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002918 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002919 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002920
2921 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2922 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002923 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002924
Dave Houlton6f9059e2017-05-02 17:15:13 -06002925 bool slice_override = false;
2926 uint32_t depth_slices = 0;
2927
2928 // Special case for copying between a 1D/2D array and a 3D image
2929 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2930 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2931 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002932 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002933 slice_override = (depth_slices != 1);
2934 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2935 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002936 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002937 slice_override = (depth_slices != 1);
2938 }
2939
Jeff Leger178b1e52020-10-05 12:22:23 -04002940 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2941 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2942 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2943 skip |=
2944 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2945 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2946 skip |=
2947 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2948 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002949 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002950 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2951 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002952 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002953 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002954
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002955 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002956 // No chance of mismatch if we're overriding depth slice count
2957 if (!slice_override) {
2958 // The number of depth slices in srcSubresource and dstSubresource must match
2959 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2960 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002961 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2962 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002963 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002964 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2965 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002966 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002967 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2968 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002969 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2970 "do not match.",
2971 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002972 }
2973 }
2974 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002975 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002976 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002977 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002978 skip |=
2979 LogError(command_buffer, vuid,
2980 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2981 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002982 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002983 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002984
Dave Houltonc991cc92018-03-06 11:08:51 -07002985 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002986 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002987 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2988 // If neither image is multi-plane the aspectMask member of src and dst must match
2989 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2990 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2991 skip |= LogError(command_buffer, vuid,
2992 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2993 "source (0x%x) destination (0x%x).",
2994 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2995 }
2996 } else {
2997 // Source image multiplane checks
2998 uint32_t planes = FormatPlaneCount(src_format);
2999 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3000 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3001 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
3002 skip |= LogError(command_buffer, vuid,
3003 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3004 i, aspect);
3005 }
3006 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3007 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3008 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3009 skip |= LogError(command_buffer, vuid,
3010 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3011 i, aspect);
3012 }
3013 // Single-plane to multi-plane
3014 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3015 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3016 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3017 skip |= LogError(command_buffer, vuid,
3018 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3019 func_name, i, aspect);
3020 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003021
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003022 // Dest image multiplane checks
3023 planes = FormatPlaneCount(dst_format);
3024 aspect = region.dstSubresource.aspectMask;
3025 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3026 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3027 skip |= LogError(command_buffer, vuid,
3028 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3029 i, aspect);
3030 }
3031 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3032 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3033 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3034 skip |= LogError(command_buffer, vuid,
3035 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3036 i, aspect);
3037 }
3038 // Multi-plane to single-plane
3039 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3040 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3041 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3042 skip |= LogError(command_buffer, vuid,
3043 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3044 func_name, i, aspect);
3045 }
3046 }
3047 } else {
3048 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003049 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3050 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003051 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003052 skip |= LogError(
3053 command_buffer, vuid,
3054 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3055 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003056 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003057 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003058
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003059 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003060 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003061 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003062 skip |=
3063 LogError(command_buffer, vuid,
3064 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3065 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003066 }
3067
3068 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003069 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003070 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003071 skip |= LogError(
3072 command_buffer, vuid,
3073 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3074 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003075 }
3076
Dave Houltonfc1a4052017-04-27 14:32:45 -06003077 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003078 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003079 if (slice_override) src_copy_extent.depth = depth_slices;
3080 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003081 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003082 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3083 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003084 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003085 "width [%1d].",
3086 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003087 }
3088
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003089 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003090 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3091 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003092 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003093 "height [%1d].",
3094 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003095 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003096 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003097 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3098 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003099 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003100 "depth [%1d].",
3101 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003102 }
3103
Dave Houltonee281a52017-12-08 13:51:02 -07003104 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003105 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003106 if (slice_override) dst_copy_extent.depth = depth_slices;
3107
3108 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003109 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003110 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3111 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003112 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003113 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003114 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003115 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003116 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003117 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3118 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003119 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003120 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003121 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003122 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003123 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003124 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3125 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003126 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003127 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003128 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003129 }
3130
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003131 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3132 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003133 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003134 for (uint32_t j = 0; j < regionCount; j++) {
3135 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003136 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003137 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003138 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003139 }
3140 }
3141 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003142
3143 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3144 if (device_extensions.vk_khr_maintenance1) {
3145 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3146 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3147 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003148 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3149 skip |= LogError(command_buffer, vuid,
3150 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3151 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003152 }
3153 } else {
3154 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3155 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3156 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003157 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3158 skip |= LogError(command_buffer, vuid,
3159 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3160 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003161 }
3162 }
3163
3164 // Check if 2D with 3D and depth not equal to 2D layerCount
3165 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3166 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3167 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003168 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3169 skip |= LogError(command_buffer, vuid,
3170 "%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 -08003171 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003172 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003173 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3174 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3175 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003176 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3177 skip |= LogError(command_buffer, vuid,
3178 "%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 -08003179 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003180 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003181 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003182
3183 // Check for multi-plane format compatiblity
3184 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3185 size_t src_format_size = 0;
3186 size_t dst_format_size = 0;
3187 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003188 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3189 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003190 } else {
3191 src_format_size = FormatElementSize(src_format);
3192 }
3193 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003194 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3195 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003196 } else {
3197 dst_format_size = FormatElementSize(dst_format);
3198 }
3199 // If size is still zero, then format is invalid and will be caught in another VU
3200 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003201 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3202 skip |= LogError(command_buffer, vuid,
3203 "%s: pRegions[%u] called with non-compatible image formats. "
3204 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3205 func_name, i, string_VkFormat(src_format),
3206 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3207 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003208 }
3209 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003210 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003211
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003212 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3213 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3214 // because because both texels are 4 bytes in size.
3215 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003216 const char *compatible_vuid =
3217 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3218 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3219 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003220 // Depth/stencil formats must match exactly.
3221 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3222 if (src_format != dst_format) {
3223 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003224 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003225 string_VkFormat(src_format), string_VkFormat(dst_format));
3226 }
3227 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003228 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003229 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003230 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003231 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003232 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003233 FormatElementSize(dst_format));
3234 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003235 }
3236 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003237
Dave Houlton33c22b72017-02-28 13:16:02 -07003238 // Source and dest image sample counts must match
3239 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003240 std::stringstream ss;
3241 ss << func_name << " called on image pair with non-identical sample counts.";
3242 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003243 skip |=
3244 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3245 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3246 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003247 }
3248
Tony-LunarG5a066372021-01-21 10:31:34 -07003249 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3250 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3251 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003252 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003253 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3254 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3255 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3256 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003257 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003258 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3259 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3260 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3261 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3262 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3263 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3264 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3265 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3266 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3267 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3268 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3269 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003270
3271 // Validation for VK_EXT_fragment_density_map
3272 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003273 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3274 skip |=
3275 LogError(command_buffer, vuid,
3276 "%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 +02003277 }
3278 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003279 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3280 skip |=
3281 LogError(command_buffer, vuid,
3282 "%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 +02003283 }
3284
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003285 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003286 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3287 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3288 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3289 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003290 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003291 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003292 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003293
3294 const char *invalid_src_layout_vuid =
3295 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3296 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3297 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3298 const char *invalid_dst_layout_vuid =
3299 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3300 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3301 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3302
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003303 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003304 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003305 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003306 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3307 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003308 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003309 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003310 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003311 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003312 }
3313
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003314 return skip;
3315}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003316
Jeff Leger178b1e52020-10-05 12:22:23 -04003317bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3318 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3319 const VkImageCopy *pRegions) const {
3320 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3321 COPY_COMMAND_VERSION_1);
3322}
3323
3324bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3325 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3326 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3327 COPY_COMMAND_VERSION_2);
3328}
3329
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003330void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3331 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3332 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003333 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3334 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003335 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003336 auto src_image_state = GetImageState(srcImage);
3337 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003338
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003339 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003340 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003341 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3342 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003343 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003344}
3345
Jeff Leger178b1e52020-10-05 12:22:23 -04003346void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3347 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3348 auto cb_node = GetCBState(commandBuffer);
3349 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3350 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3351
3352 // Make sure that all image slices are updated to correct layout
3353 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3354 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3355 pCopyImageInfo->srcImageLayout);
3356 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3357 pCopyImageInfo->dstImageLayout);
3358 }
3359}
3360
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003361// Returns true if sub_rect is entirely contained within rect
3362static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3363 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 -07003364 (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 -07003365 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003366 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003367 return true;
3368}
3369
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003370bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003371 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003372 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3373 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003374 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003375 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3376 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003377 if (primary_cb_state) {
3378 image_view_state = primary_cb_state->GetActiveAttachmentImageViewState(fb_attachment);
3379 } else {
3380 image_view_state = GetCBState(command_buffer)->GetActiveAttachmentImageViewState(fb_attachment);
3381 }
John Zulauff2582972019-02-09 14:53:30 -07003382 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003383
3384 for (uint32_t j = 0; j < rect_count; j++) {
3385 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003386 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3387 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3388 "the current render pass instance.",
3389 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003390 }
3391
3392 if (image_view_state) {
3393 // The layers specified by a given element of pRects must be contained within every attachment that
3394 // pAttachments refers to
3395 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3396 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3397 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003398 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3399 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3400 "of pAttachment[%d].",
3401 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003402 }
3403 }
3404 }
3405 return skip;
3406}
3407
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003408bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3409 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003410 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003411 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003412 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003413 if (!cb_node) return skip;
3414
Petr Kraus2dffb382019-08-10 02:52:12 +02003415 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003416
3417 // Validate that attachment is in reference list of active subpass
3418 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003419 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003420 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003421 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003422 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003423 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003424
John Zulauf3a548ef2019-02-01 16:14:07 -07003425 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3426 auto clear_desc = &pAttachments[attachment_index];
3427 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003428 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003429
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003430 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3431 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3432 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3433 attachment_index);
3434 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3435 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3436 skip |=
3437 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3438 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3439 attachment_index);
3440 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003441 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3442 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3443 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3444 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003445 skip |= LogError(
3446 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3447 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3448 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3449 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003450 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003451 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003452
John Zulauff2582972019-02-09 14:53:30 -07003453 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3454 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003455 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003456 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3457 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3458 " subpass %u. colorAttachmentCount=%u",
3459 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003460 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003461 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003462 }
John Zulauff2582972019-02-09 14:53:30 -07003463 fb_attachment = color_attachment;
3464
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003465 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3466 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3467 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3468 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3469 "of a color attachment.",
3470 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003471 }
3472 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003473 bool subpass_depth = false;
3474 bool subpass_stencil = false;
3475 if (subpass_desc->pDepthStencilAttachment &&
3476 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3477 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3478 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3479 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3480 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003481 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003482 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3483 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003484 skip |= LogError(
3485 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3486 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003487 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003488 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003489 }
3490 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003491 skip |= LogError(
3492 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3493 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003494 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003495 attachment_index);
3496 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003497 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003498 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003499 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003500 if (subpass_depth) {
3501 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3502 "vkCmdClearAttachments()");
3503 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003504 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003505 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003506 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3507 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003508 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003509
3510 // Once the framebuffer attachment is found, can get the image view state
3511 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3512 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3513 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003514 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003515 if (image_view_state != nullptr) {
3516 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3517 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3518 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3519 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3520 }
3521 }
John Zulauf441558b2019-08-12 11:47:39 -06003522 }
3523 }
3524 return skip;
3525}
3526
3527void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3528 const VkClearAttachment *pAttachments, uint32_t rectCount,
3529 const VkClearRect *pRects) {
3530 auto *cb_node = GetCBState(commandBuffer);
3531 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003532 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3533 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003534 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3535 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3536 const auto clear_desc = &pAttachments[attachment_index];
3537 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3538 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3539 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3540 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3541 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3542 subpass_desc->pDepthStencilAttachment) {
3543 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3544 }
3545 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003546 if (!clear_rect_copy) {
3547 // We need a copy of the clear rectangles that will persist until the last lambda executes
3548 // but we want to create it as lazily as possible
3549 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003550 }
John Zulauf441558b2019-08-12 11:47:39 -06003551 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3552 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003553 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003554 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003555 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003556 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3557 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003558 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003559 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003560 return skip;
3561 };
3562 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003563 }
3564 }
3565 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003566}
3567
Jeff Leger178b1e52020-10-05 12:22:23 -04003568template <typename RegionType>
3569bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3570 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3571 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003572 const auto *cb_node = GetCBState(commandBuffer);
3573 const auto *src_image_state = GetImageState(srcImage);
3574 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003575 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3576 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3577 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3578 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003579
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003580 bool skip = false;
3581 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003582 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3583 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3584 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3585 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003586 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003587 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3588 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3589 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3590 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3591 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3592 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3593 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3594 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003595
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003596 // Validation for VK_EXT_fragment_density_map
3597 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003598 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003599 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003600 "%s: srcImage must not have been created with flags containing "
3601 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3602 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003603 }
3604 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003605 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003606 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003607 "%s: dstImage must not have been created with flags containing "
3608 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3609 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003610 }
3611
Cort Stratton7df30962018-05-17 19:45:57 -07003612 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003613 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003614 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3615 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003616 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003617 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3618 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3619 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003620 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003621 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3622 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3623 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3624 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3625 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3626 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003627 // For each region, the number of layers in the image subresource should not be zero
3628 // For each region, src and dest image aspect must be color only
3629 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003630 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003631 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3632 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003633 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3634 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3635 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003636 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003637 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3638 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003639 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003640 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3641 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3642 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3643 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3644 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3645 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003646 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003647 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3648 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003649 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003650 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003651
3652 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003653 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003654 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3655 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003656 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003657 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003658 }
Cort Stratton7df30962018-05-17 19:45:57 -07003659 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003660 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3661 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003662 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003663 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003664 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3665 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003666 }
3667
3668 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3669 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3670
3671 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003672 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003673 LogObjectList objlist(cb_node->commandBuffer());
3674 objlist.add(src_image_state->image());
3675 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003676 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3677 skip |= LogError(objlist, vuid,
3678 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003679 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003680 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003681 }
3682 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003683 LogObjectList objlist(cb_node->commandBuffer());
3684 objlist.add(src_image_state->image());
3685 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003686 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3687 skip |= LogError(objlist, vuid,
3688 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003689 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003690 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003691 }
3692 }
3693
3694 if (VK_IMAGE_TYPE_1D == src_image_type) {
3695 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003696 LogObjectList objlist(cb_node->commandBuffer());
3697 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003698 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3699 skip |= LogError(objlist, vuid,
3700 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003701 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003702 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003703 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003704 }
3705 }
3706 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3707 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003708 LogObjectList objlist(cb_node->commandBuffer());
3709 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003710 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3711 skip |= LogError(objlist, vuid,
3712 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003713 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003714 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003715 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003716 }
3717 }
3718
3719 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3720 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003721 LogObjectList objlist(cb_node->commandBuffer());
3722 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003723 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3724 skip |= LogError(objlist, vuid,
3725 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003726 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003727 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003728 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003729 }
3730 }
3731 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3732 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003733 LogObjectList objlist(cb_node->commandBuffer());
3734 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003735 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3736 skip |= LogError(objlist, vuid,
3737 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003738 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003739 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003740 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003741 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003742 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003743
3744 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003745 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003746 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3747 // developer
3748 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3749 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003750 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003751 LogObjectList objlist(cb_node->commandBuffer());
3752 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003753 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3754 skip |= LogError(objlist, vuid,
3755 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003756 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003757 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003758 region.extent.width, subresource_extent.width);
3759 }
3760
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003761 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003762 LogObjectList objlist(cb_node->commandBuffer());
3763 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003764 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3765 skip |= LogError(objlist, vuid,
3766 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003767 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003768 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003769 region.extent.height, subresource_extent.height);
3770 }
3771
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003772 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003773 LogObjectList objlist(cb_node->commandBuffer());
3774 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003775 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3776 skip |= LogError(objlist, vuid,
3777 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003778 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003779 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003780 region.extent.depth, subresource_extent.depth);
3781 }
3782 }
3783
3784 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003785 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003786 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3787 // developer
3788 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3789 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003790 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003791 LogObjectList objlist(cb_node->commandBuffer());
3792 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003793 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3794 skip |= LogError(objlist, vuid,
3795 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003796 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003797 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003798 region.extent.width, subresource_extent.width);
3799 }
3800
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003801 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003802 LogObjectList objlist(cb_node->commandBuffer());
3803 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003804 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3805 skip |= LogError(objlist, vuid,
3806 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003807 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003808 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003809 region.extent.height, subresource_extent.height);
3810 }
3811
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003812 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003813 LogObjectList objlist(cb_node->commandBuffer());
3814 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003815 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3816 skip |= LogError(objlist, vuid,
3817 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003818 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003819 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003820 region.extent.depth, subresource_extent.depth);
3821 }
3822 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003823 }
3824
3825 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003826 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003827 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 -04003828 func_name, string_VkFormat(src_image_state->createInfo.format),
3829 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003830 }
3831 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003832 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003833 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003834 string_VkImageType(src_image_state->createInfo.imageType),
3835 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003836 }
3837 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003838 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003839 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 -07003840 }
3841 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003843 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 -04003844 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003845 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003846 } else {
3847 assert(0);
3848 }
3849 return skip;
3850}
3851
Jeff Leger178b1e52020-10-05 12:22:23 -04003852bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3853 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3854 const VkImageResolve *pRegions) const {
3855 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3856 COPY_COMMAND_VERSION_1);
3857}
3858
3859bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3860 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3861 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3862 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3863 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3864}
3865
3866template <typename RegionType>
3867bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3868 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3869 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003870 const auto *cb_node = GetCBState(commandBuffer);
3871 const auto *src_image_state = GetImageState(srcImage);
3872 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003873
Jeff Leger178b1e52020-10-05 12:22:23 -04003874 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3875 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3876 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3877
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003878 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003879 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003880 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003881 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003882 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003883 const char *vuid;
3884 const char *location;
3885 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3886 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3887 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3888 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3889 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3890 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3891 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3892 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3893 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3894 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3895 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3896 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3897 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3898 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3899 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3900 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04003901 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003902 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3903 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3904 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3905 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3906 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3907 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3908 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3909 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3910 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3911 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003912
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003913 // Validation for VK_EXT_fragment_density_map
3914 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003915 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003916 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003917 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3918 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003919 }
3920 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003921 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003922 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003923 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3924 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003925 }
3926
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003927 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003928
Dave Houlton33c2d252017-06-09 17:08:32 -06003929 VkFormat src_format = src_image_state->createInfo.format;
3930 VkFormat dst_format = dst_image_state->createInfo.format;
3931 VkImageType src_type = src_image_state->createInfo.imageType;
3932 VkImageType dst_type = dst_image_state->createInfo.imageType;
3933
Cort Stratton186b1a22018-05-01 20:18:06 -04003934 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003935 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3936 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3937 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003938 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003939 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003940 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003941 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003942 }
3943
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003944 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003945 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3946 skip |= LogError(device, vuid,
3947 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003948 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003949 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003950 }
3951
3952 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003953 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3954 skip |= LogError(device, vuid,
3955 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003956 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003957 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003958 }
3959
Dave Houlton33c2d252017-06-09 17:08:32 -06003960 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003961 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003962 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003963 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003964 }
3965
Dave Houlton33c2d252017-06-09 17:08:32 -06003966 // Validate consistency for unsigned formats
3967 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3968 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003969 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003970 << "the other one must also have unsigned integer format. "
3971 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003972 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003973 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003974 }
3975
3976 // Validate consistency for signed formats
3977 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3978 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003979 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003980 << "the other one must also have signed integer format. "
3981 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003983 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003984 }
3985
3986 // Validate filter for Depth/Stencil formats
3987 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3988 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003989 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003990 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003991 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003992 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003993 }
3994
3995 // Validate aspect bits and formats for depth/stencil images
3996 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3997 if (src_format != dst_format) {
3998 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003999 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 -06004000 << "stencil, the other one must have exactly the same format. "
4001 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4002 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004003 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004004 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004005 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004006 } // Depth or Stencil
4007
4008 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004009 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004010 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4011 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4012 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4013 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4014 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4015 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004016 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004017 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4018 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4019 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4020 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4021 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4022 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004023 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004024 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004025 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004026 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004027 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004028 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4029 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004030 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004031 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4032 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4033 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4034 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4035 skip |=
4036 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4038 skip |=
4039 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4040 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004041 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004042 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4043 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004044 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004045 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004046 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004047 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4048 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004049 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004050 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004051 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004052 }
Dave Houlton48989f32017-05-26 15:01:46 -06004053 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4054 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004055 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004056 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004057 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004058 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004059
4060 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004061 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004062 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4063 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004064 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004065 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004066 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004067
Dave Houlton48989f32017-05-26 15:01:46 -06004068 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004069 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4070 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004071 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004072 }
Dave Houlton48989f32017-05-26 15:01:46 -06004073
Dave Houlton33c2d252017-06-09 17:08:32 -06004074 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004075 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004076 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004077 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004078 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004079 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004080 }
4081
4082 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004083 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004084 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004085 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4086 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004087 }
4088
Dave Houlton48989f32017-05-26 15:01:46 -06004089 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004090 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004091 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004092 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004093 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004094 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004095 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4096 "of (%1d, %1d). These must be (0, 1).",
4097 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004098 }
4099 }
4100
Dave Houlton33c2d252017-06-09 17:08:32 -06004101 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004102 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004103 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004104 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004105 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4106 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4107 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004108 }
4109 }
4110
Dave Houlton33c2d252017-06-09 17:08:32 -06004111 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004112 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4113 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004114 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004115 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004116 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004117 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4118 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004119 }
4120 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4121 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004122 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004123 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004124 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004125 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4126 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004127 }
4128 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4129 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004130 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004131 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004132 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004133 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4134 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004135 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004136 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004137 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004138 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004139 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004140 }
Dave Houlton48989f32017-05-26 15:01:46 -06004141
4142 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004143 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004144 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004145 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004146 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004147 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004148 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4149 "(%1d, %1d). These must be (0, 1).",
4150 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004151 }
4152 }
4153
Dave Houlton33c2d252017-06-09 17:08:32 -06004154 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004155 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004156 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004157 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004158 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004159 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004160 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004161 }
4162 }
4163
Dave Houlton33c2d252017-06-09 17:08:32 -06004164 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004165 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4166 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004167 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004168 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004169 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004170 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4171 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004172 }
4173 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4174 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004175 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004176 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004177 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004178 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4179 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004180 }
4181 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4182 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004183 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004184 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004185 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004186 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4187 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004188 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004189 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004190 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004191 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004192 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004193 }
4194
Dave Houlton33c2d252017-06-09 17:08:32 -06004195 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4196 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4197 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004198 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004199 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004200 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4201 "layerCount other than 1.",
4202 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004203 }
4204 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004205 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004206 } else {
4207 assert(0);
4208 }
4209 return skip;
4210}
4211
Jeff Leger178b1e52020-10-05 12:22:23 -04004212bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4213 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4214 const VkImageBlit *pRegions, VkFilter filter) const {
4215 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4216 COPY_COMMAND_VERSION_1);
4217}
4218
4219bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4220 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4221 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4222 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4223}
4224
4225template <typename RegionType>
4226void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4227 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4228 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004229 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004230 auto src_image_state = GetImageState(srcImage);
4231 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004232
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004233 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004234 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004235 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4236 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004237 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004238}
4239
Jeff Leger178b1e52020-10-05 12:22:23 -04004240void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4241 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4242 const VkImageBlit *pRegions, VkFilter filter) {
4243 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4244 pRegions, filter);
4245 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4246}
4247
4248void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4249 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4250 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4251 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4252 pBlitImageInfo->filter);
4253}
4254
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004255GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004256 // This approach allows for a single hash lookup or/create new
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004257 auto &layout_map = map[image_state.image()];
John Zulauf17708d02021-02-22 11:20:58 -07004258 if (!layout_map) {
4259 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004260 }
John Zulauf17708d02021-02-22 11:20:58 -07004261 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004262}
4263
4264const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4265 auto it = map.find(image);
4266 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004267 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004268 }
4269 return nullptr;
4270}
4271
Jeremy Gebben53631302021-04-13 16:46:37 -06004272// Helper to update the Global or Overlay layout map
4273struct GlobalLayoutUpdater {
4274 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4275 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4276 dst = src.current_layout;
4277 return true;
4278 }
4279 return false;
4280 }
4281
4282 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4283 layer_data::optional<VkImageLayout> result;
4284 if (src.current_layout != image_layout_map::kInvalidLayout) {
4285 result.emplace(src.current_layout);
4286 }
4287 return result;
4288 }
4289};
4290
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004291// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
John Zulauf2076e812020-01-08 14:55:54 -07004292bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004293 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004294 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004295 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004296 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004297 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004298 for (const auto &layout_map_entry : pCB->image_layout_map) {
4299 const auto image = layout_map_entry.first;
4300 const auto *image_state = GetImageState(image);
4301 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004302 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004303 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004304 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004305 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004306
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004307 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004308 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4309 if (global_map == nullptr) {
4310 global_map = &empty_map;
4311 }
4312
4313 // Note: don't know if it would matter
4314 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4315
Jeremy Gebben53631302021-04-13 16:46:37 -06004316 auto pos = layout_map.begin();
4317 const auto end = layout_map.end();
4318 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4319 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004320 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004321 VkImageLayout initial_layout = pos->second.initial_layout;
4322 assert(initial_layout != image_layout_map::kInvalidLayout);
4323 if (initial_layout == image_layout_map::kInvalidLayout) {
4324 continue;
4325 }
4326
John Zulauf2076e812020-01-08 14:55:54 -07004327 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004328
John Zulauf2076e812020-01-08 14:55:54 -07004329 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 -07004330 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004331 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004332 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004333 image_layout = current_layout->pos_B->lower_bound->second;
4334 }
4335 const auto intersected_range = pos->first & current_layout->range;
4336 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4337 // TODO: Set memory invalid which is in mem_tracker currently
4338 } else if (image_layout != initial_layout) {
4339 // Need to look up the inital layout *state* to get a bit more information
4340 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4341 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4342 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4343 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004344 // We can report all the errors for the intersected range directly
4345 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004346 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004347 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004348 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004349 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004350 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004351 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004352 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004353 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004354 }
4355 }
John Zulauf2076e812020-01-08 14:55:54 -07004356 if (pos->first.includes(intersected_range.end)) {
4357 current_layout.seek(intersected_range.end);
4358 } else {
4359 ++pos;
4360 if (pos != end) {
4361 current_layout.seek(pos->first.begin);
4362 }
4363 }
John Zulauff660ad62019-03-23 07:16:05 -06004364 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004365 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004366 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004367 }
John Zulauff660ad62019-03-23 07:16:05 -06004368
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004369 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004370}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004371
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004372void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
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;
John Zulauf2076e812020-01-08 14:55:54 -07004375 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004376 const auto *image_state = GetImageState(image);
4377 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004378 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004379 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004380 }
4381}
4382
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004383// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004384// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4385// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004386bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4387 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004388 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004389 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004390 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4391
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004392 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004393 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4394 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004395 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004396 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4397 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4398 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004399 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004400 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004401 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004402 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4403 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4404 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004405 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004406 string_VkImageLayout(first_layout));
4407 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4408 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004409 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004410 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004411 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004412 }
4413 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004414
4415 // Same as above for loadOp, but for stencilLoadOp
4416 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4417 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4418 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4419 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4420 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004421 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004422 string_VkImageLayout(first_layout));
4423 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4424 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4425 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004426 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004427 string_VkImageLayout(first_layout));
4428 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4429 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4430 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004431 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004432 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004433 }
4434 }
4435
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004436 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004437}
4438
Mark Lobodzinski96210742017-02-09 10:33:46 -07004439// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4440// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004441template <typename T1>
4442bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4443 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4444 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004445 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004446 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004447 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004448 if (strict) {
4449 correct_usage = ((actual & desired) == desired);
4450 } else {
4451 correct_usage = ((actual & desired) != 0);
4452 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004453
Mark Lobodzinski96210742017-02-09 10:33:46 -07004454 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004455 // All callers should have a valid VUID
4456 assert(msgCode != kVUIDUndefined);
4457 skip =
4458 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4459 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004460 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004461 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004462}
4463
4464// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4465// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004466bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004467 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004468 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004469 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004470}
4471
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004472bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004473 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004474 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004475 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4476 if ((image_format_features & desired) != desired) {
4477 // Same error, but more details if it was an AHB external format
4478 if (image_state->has_ahb_format == true) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004479 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004480 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4481 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4482 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004483 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004484 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004485 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004486 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4487 "with tiling %s.",
4488 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004489 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004490 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004491 }
4492 }
4493 return skip;
4494}
4495
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004496bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004497 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004498 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004499 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004500 // layerCount must not be zero
4501 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004502 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004503 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004504 }
4505 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004506 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004507 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004508 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004509 }
4510 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004511 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 -06004512 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004513 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4514 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4515 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004516 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004517 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4518 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4519 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004520 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004521 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4522 member);
4523 }
Cort Strattond619a302018-05-17 19:46:32 -07004524 return skip;
4525}
4526
Mark Lobodzinski96210742017-02-09 10:33:46 -07004527// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4528// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004529bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004530 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004531 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004532 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004533}
4534
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004535bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004536 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004537 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004538
4539 const VkDeviceSize &range = pCreateInfo->range;
4540 if (range != VK_WHOLE_SIZE) {
4541 // Range must be greater than 0
4542 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004543 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004544 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004545 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4546 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004547 }
4548 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004549 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4550 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004551 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004552 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004553 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4554 "(%" PRIu32 ").",
4555 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004556 }
4557 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004558 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004559 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004560 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004561 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4562 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4563 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004564 }
4565 // The sum of range and offset must be less than or equal to the size of buffer
4566 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004567 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004568 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004569 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4570 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4571 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004572 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004573 } else {
4574 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4575
4576 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4577 // VkPhysicalDeviceLimits::maxTexelBufferElements
4578 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4579 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004580 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004581 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4582 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4583 "), divided by the element size of the format (%" PRIu32
4584 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4585 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4586 device_limits->maxTexelBufferElements);
4587 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004588 }
4589 return skip;
4590}
4591
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004592bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004593 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004594 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004595 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4596 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004597 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004598 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004599 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4600 "be supported for uniform texel buffers",
4601 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004602 }
4603 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4604 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004605 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004606 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004607 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4608 "be supported for storage texel buffers",
4609 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004610 }
4611 return skip;
4612}
4613
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004614bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004615 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004616 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004617
Dave Houltond8ed0212018-05-16 17:18:24 -06004618 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004619
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004620 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004621 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004622 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004623 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004624 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4625 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004626 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004627 }
4628 }
4629
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004630 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004631 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004632 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004633 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004634 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004635 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4636 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004637 }
4638 }
4639
Mike Schuchardt2df08912020-12-15 16:28:09 -08004640 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004641 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4642 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004643 skip |= LogError(
4644 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004645 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004646 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004647 }
4648
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004649 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004650 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4651 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4652 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004653 }
4654
sfricke-samsungedce77a2020-07-03 22:35:13 -07004655 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4656 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4657 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4658 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4659 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4660 }
4661 const VkBufferCreateFlags invalid_flags =
4662 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4663 if ((pCreateInfo->flags & invalid_flags) != 0) {
4664 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4665 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4666 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4667 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4668 }
4669 }
4670
Mark Lobodzinski96210742017-02-09 10:33:46 -07004671 return skip;
4672}
4673
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004674bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004675 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004676 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004677 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004678 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4679 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004680 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004681 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4682 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004683 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004684 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4685 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4686 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004687
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004688 // Buffer view offset must be less than the size of buffer
4689 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004690 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004691 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004692 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4693 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004694 }
4695
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004696 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004697 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4698 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4699 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004700 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4701 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004702 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004703 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004704 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4705 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004706 }
4707
4708 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004709 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4710 if ((element_size % 3) == 0) {
4711 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004712 }
4713 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004714 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004715 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4716 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004717 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004718 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004719 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004720 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004721 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004722 "vkCreateBufferView(): If buffer was created with usage containing "
4723 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004724 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4725 ") must be a multiple of the lesser of "
4726 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4727 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4728 "(%" PRId32
4729 ") is VK_TRUE, the size of a texel of the requested format. "
4730 "If the size of a texel is a multiple of three bytes, then the size of a "
4731 "single component of format is used instead",
4732 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4733 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4734 }
4735 }
4736 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004737 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004738 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4739 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004740 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004741 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004742 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004743 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004744 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004745 "vkCreateBufferView(): If buffer was created with usage containing "
4746 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004747 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4748 ") must be a multiple of the lesser of "
4749 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4750 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4751 "(%" PRId32
4752 ") is VK_TRUE, the size of a texel of the requested format. "
4753 "If the size of a texel is a multiple of three bytes, then the size of a "
4754 "single component of format is used instead",
4755 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4756 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4757 }
4758 }
4759 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004760
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004761 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004762
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004763 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004764 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004765 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004766}
4767
Mark Lobodzinski602de982017-02-09 11:01:33 -07004768// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004769bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004770 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004771 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004772 const IMAGE_STATE *image_state = GetImageState(image);
4773 // checks color format and (single-plane or non-disjoint)
4774 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004775 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004776 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004777 skip |= LogError(
4778 image, vuid,
4779 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4780 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004781 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004782 skip |= LogError(image, vuid,
4783 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4784 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4785 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004786 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004787 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004788 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004789 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004790 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4791 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4792 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004793 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004794 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004795 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4796 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4797 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004798 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004799 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004800 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004801 skip |= LogError(image, vuid,
4802 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4803 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4804 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004805 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004806 skip |= LogError(image, vuid,
4807 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4808 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4809 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004810 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004811 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004812 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004813 skip |= LogError(image, vuid,
4814 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4815 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4816 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004817 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004818 skip |= LogError(image, vuid,
4819 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4820 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4821 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004822 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004823 } else if (FormatIsMultiplane(format)) {
4824 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4825 if (3 == FormatPlaneCount(format)) {
4826 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4827 }
4828 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004829 skip |= LogError(image, vuid,
4830 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4831 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4832 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004833 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004834 }
4835 return skip;
4836}
4837
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004838bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4839 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004840 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004841 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004842 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004843
4844 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004845 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004846 skip |= LogError(image, errorCodes.base_mip_err,
4847 "%s: %s.baseMipLevel (= %" PRIu32
4848 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4849 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004850 }
Petr Kraus4d718682017-05-18 03:38:41 +02004851
Petr Krausffa94af2017-08-08 21:46:02 +02004852 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4853 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004854 skip |=
4855 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004856 } else {
4857 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004858
Petr Krausffa94af2017-08-08 21:46:02 +02004859 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004860 skip |= LogError(image, errorCodes.mip_count_err,
4861 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4862 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4863 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4864 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004865 }
Petr Kraus4d718682017-05-18 03:38:41 +02004866 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004867 }
Petr Kraus4d718682017-05-18 03:38:41 +02004868
4869 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004870 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004871 skip |= LogError(image, errorCodes.base_layer_err,
4872 "%s: %s.baseArrayLayer (= %" PRIu32
4873 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4874 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004875 }
Petr Kraus4d718682017-05-18 03:38:41 +02004876
Petr Krausffa94af2017-08-08 21:46:02 +02004877 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4878 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004879 skip |=
4880 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004881 } else {
4882 const uint64_t necessary_layer_count =
4883 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004884
Petr Krausffa94af2017-08-08 21:46:02 +02004885 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004886 skip |= LogError(image, errorCodes.layer_count_err,
4887 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4888 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4889 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4890 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004891 }
Petr Kraus4d718682017-05-18 03:38:41 +02004892 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004893 }
Petr Kraus4d718682017-05-18 03:38:41 +02004894
Mark Lobodzinski602de982017-02-09 11:01:33 -07004895 return skip;
4896}
4897
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004898bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004899 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004900 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004901 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004902 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004903 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 +02004904
David McFarland2853f2f2020-11-30 15:50:39 -04004905 uint32_t image_layer_count;
4906
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004907 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004908 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004909 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004910 image_layer_count = extent.depth;
4911 } else {
4912 image_layer_count = image_state->createInfo.arrayLayers;
4913 }
4914
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004915 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004916
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004917 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4918 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4919 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4920 subresource_range_error_codes.base_layer_err =
4921 is_khr_maintenance1
4922 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4923 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4924 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4925 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4926 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4927 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004928
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004929 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004930 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004931 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004932}
4933
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004934bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004935 const VkImageSubresourceRange &subresourceRange,
4936 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004937 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4938 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4939 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4940 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4941 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004942
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004943 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004944 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004945 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004946}
4947
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004948bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004949 const VkImageSubresourceRange &subresourceRange,
4950 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004951 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4952 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4953 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4954 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4955 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004956
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004957 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004958 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004959 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004960}
4961
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07004962bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004963 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004964 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004965 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07004966 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02004967}
4968
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004969namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004970using sync_vuid_maps::GetBarrierQueueVUID;
4971using sync_vuid_maps::kQueueErrorSummary;
4972using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004973
4974class ValidatorState {
4975 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07004976 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004977 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
4978 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07004979 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004980 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004981 barrier_handle_(barrier_handle),
4982 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004983 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
4984 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
4985
4986 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
4987 // 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 -07004988 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
4989 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004990 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004991 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
4992 loc_.Message().c_str(), GetTypeString(),
4993 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
4994 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004995 }
4996
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004997 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
4998 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004999 const char *src_annotation = GetFamilyAnnotation(src_family);
5000 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5001 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005002 objects_, val_code,
5003 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5004 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5005 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005006 }
5007
5008 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5009 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5010 // application input.
5011 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5012 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005013 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005014 uint32_t queue_family = queue_state->queueFamilyIndex;
5015 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005016 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005017 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5018 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5019 return device_data->LogError(
5020 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005021 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005022 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005023 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005024 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005025 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005026 }
5027 return false;
5028 }
5029 // Logical helpers for semantic clarity
5030 inline bool KhrExternalMem() const { return mem_ext_; }
5031 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5032 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5033 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5034 }
5035
5036 // Helpers for LogMsg
5037 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5038
5039 // Descriptive text for the various types of queue family index
5040 const char *GetFamilyAnnotation(uint32_t family) const {
5041 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5042 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5043 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5044 const char *valid = " (VALID)";
5045 const char *invalid = " (INVALID)";
5046 switch (family) {
5047 case VK_QUEUE_FAMILY_EXTERNAL:
5048 return external;
5049 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5050 return foreign;
5051 case VK_QUEUE_FAMILY_IGNORED:
5052 return ignored;
5053 default:
5054 if (IsValid(family)) {
5055 return valid;
5056 }
5057 return invalid;
5058 };
5059 }
5060 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5061 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5062
5063 protected:
5064 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005065 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005066 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005067 const VulkanTypedHandle barrier_handle_;
5068 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005069 const uint32_t limit_;
5070 const bool mem_ext_;
5071};
5072
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005073bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005074 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5075 bool skip = false;
5076
5077 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5078 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5079 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5080 if (val.KhrExternalMem()) {
5081 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005082 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5083 // this requirement is removed by VK_KHR_synchronization2
5084 if (!(src_ignored || dst_ignored) && !sync2) {
5085 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005086 }
5087 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5088 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005089 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005090 }
5091 } else {
5092 // VK_SHARING_MODE_EXCLUSIVE
5093 if (src_queue_family != dst_queue_family) {
5094 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005095 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005096 }
5097 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005098 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005099 }
5100 }
5101 }
5102 } else {
5103 // No memory extension
5104 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005105 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5106 // this requirement is removed by VK_KHR_synchronization2
5107 if ((!src_ignored || !dst_ignored) && !sync2) {
5108 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005109 }
5110 } else {
5111 // VK_SHARING_MODE_EXCLUSIVE
5112 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005113 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005114 }
5115 }
5116 }
5117 return skip;
5118}
5119} // namespace barrier_queue_families
5120
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005121bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005122 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005123 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5124 uint32_t dst_queue_family) {
5125 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005126 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005127 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5128}
5129
5130// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005131template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005132bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5133 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005134 // State data is required
5135 if (!state_data) {
5136 return false;
5137 }
5138
5139 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005140 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005141 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005142 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5143 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005144 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005145}
5146
5147// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005148template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005149bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5150 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005151 // State data is required
5152 if (!state_data) {
5153 return false;
5154 }
5155
5156 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005157 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005158 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005159 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5160 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005161 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5162}
5163
5164template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005165bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005166 const Barrier &mem_barrier) const {
5167 using sync_vuid_maps::BufferError;
5168 using sync_vuid_maps::GetBufferBarrierVUID;
5169
5170 bool skip = false;
5171
5172 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5173
5174 // Validate buffer barrier queue family indices
5175 auto buffer_state = GetBufferState(mem_barrier.buffer);
5176 if (buffer_state) {
5177 auto buf_loc = loc.dot(Field::buffer);
5178 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005179 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005180
5181 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5182
5183 auto buffer_size = buffer_state->createInfo.size;
5184 if (mem_barrier.offset >= buffer_size) {
5185 auto offset_loc = loc.dot(Field::offset);
5186 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5187
5188 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5189 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5190 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5191 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5192 auto size_loc = loc.dot(Field::size);
5193 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5194 skip |= LogError(objects, vuid,
5195 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5196 ".",
5197 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5198 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5199 }
5200 if (mem_barrier.size == 0) {
5201 auto size_loc = loc.dot(Field::size);
5202 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5203 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5204 report_data->FormatHandle(mem_barrier.buffer).c_str());
5205 }
5206 }
5207 return skip;
5208}
5209
5210template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005211bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005212 const Barrier &mem_barrier) const {
5213 bool skip = false;
5214
5215 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5216
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005217 bool is_ilt = true;
5218 if (enabled_features.synchronization2_features.synchronization2) {
5219 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5220 }
5221
5222 if (is_ilt) {
5223 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5224 auto layout_loc = loc.dot(Field::newLayout);
5225 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5226 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005227 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005228 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005229 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005230 }
5231
5232 auto image_data = GetImageState(mem_barrier.image);
5233 if (image_data) {
5234 auto image_loc = loc.dot(Field::image);
5235
John Zulaufbea70432021-02-23 07:03:12 -07005236 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005237
5238 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5239
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005240 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005241 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005242
5243 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5244 }
5245 return skip;
5246}
5247
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005248bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5249 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5250 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005251 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5252 const VkImageMemoryBarrier *pImageMemBarriers) const {
5253 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06005254 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005255 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005256
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005257 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5258 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005259 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebbenefead332021-06-18 08:22:44 -06005260 skip |= ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005261 }
5262 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5263 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005264 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbenefead332021-06-18 08:22:44 -06005265 auto op_type = cb_state->ComputeBarrierOperationsType(mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005266 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005267 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5268 }
5269 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005270 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005271 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5272 }
5273 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5274 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005275 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebbenefead332021-06-18 08:22:44 -06005276 auto op_type = cb_state->ComputeBarrierOperationsType(mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005277 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005278 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5279 }
5280 return skip;
5281}
5282
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005283bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005284 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005285 bool skip = false;
5286
5287 if (cb_state->activeRenderPass) {
5288 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5289 if (skip) return true; // Early return to avoid redundant errors from below calls
5290 }
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06005291 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005292 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5293 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005294 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebbenefead332021-06-18 08:22:44 -06005295 skip |= ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005296 }
5297 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5298 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005299 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbenefead332021-06-18 08:22:44 -06005300 auto op_type = cb_state->ComputeBarrierOperationsType(mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005301 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5302 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5303 }
5304 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005305 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005306 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5307 }
5308
5309 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5310 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005311 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbenefead332021-06-18 08:22:44 -06005312 auto op_type = cb_state->ComputeBarrierOperationsType(mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005313 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5314 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5315 }
5316
5317 return skip;
5318}
5319
5320template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005321bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, BarrierOperationsType op_type,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005322 VkQueueFlags queue_flags, const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
5323 VkPipelineStageFlags dst_stage_mask) const {
5324 bool skip = false;
5325 if (op_type == kAllRelease || op_type == kGeneral) {
5326 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5327 }
5328 if (op_type == kAllAcquire || op_type == kGeneral) {
5329 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5330 }
5331 return skip;
5332}
5333
5334template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005335bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, BarrierOperationsType op_type,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005336 VkQueueFlags queue_flags, const Barrier &barrier) const {
5337 bool skip = false;
Jeremy Gebbenefead332021-06-18 08:22:44 -06005338 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005339 if (op_type == kAllRelease || op_type == kGeneral) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005340 skip |=
5341 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5342 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005343
5344 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005345 if (op_type == kAllAcquire || op_type == kGeneral) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005346 skip |=
5347 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5348 }
5349 return skip;
5350}
5351
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005352bool CoreChecks::ValidateSubpassBarrier(const LogObjectList &objects, const Location &loc, VkQueueFlags queue_flags,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005353 const VkSubpassDependency2 &barrier) const {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005354 bool skip = false;
5355 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(barrier.pNext);
5356 if (mem_barrier) {
5357 if (enabled_features.synchronization2_features.synchronization2) {
5358 if (barrier.srcAccessMask != 0) {
5359 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5360 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5361 loc.dot(Field::srcAccessMask).Message().c_str());
5362 }
5363 if (barrier.dstAccessMask != 0) {
5364 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5365 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5366 loc.dot(Field::dstAccessMask).Message().c_str());
5367 }
5368 if (barrier.srcStageMask != 0 || barrier.dstStageMask != 0) {
5369 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5370 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5371 loc.dot(Field::srcStageMask).Message().c_str());
5372 }
5373 if (barrier.dstStageMask != 0) {
5374 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5375 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5376 loc.dot(Field::dstStageMask).Message().c_str());
5377 }
5378
5379 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc.dot(Field::pNext), kGeneral, queue_flags, *mem_barrier);
5380 return skip;
5381 } else {
5382 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5383 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5384 loc.Message().c_str());
5385 }
5386 }
5387 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, barrier);
5388 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005389}
5390
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005391bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5392 const VkImageUsageFlags image_usage) const {
5393 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5394 bool skip = false;
5395
5396 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5397 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5398
5399 if (image_state->has_ahb_format == true) {
5400 // AHB image view and image share same feature sets
5401 tiling_features = image_state->format_features;
5402 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5403 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5404 assert(device_extensions.vk_ext_image_drm_format_modifier);
5405 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5406 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005407 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005408
5409 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5410 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5411 nullptr};
5412 format_properties_2.pNext = (void *)&drm_properties_list;
5413 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5414
nyorain38a9d232021-03-06 13:06:12 +01005415 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5416 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5417 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5418
5419 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5420
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005421 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5422 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5423 0) {
5424 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5425 }
5426 }
5427 } else {
5428 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5429 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5430 : format_properties.optimalTilingFeatures;
5431 }
5432
5433 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005434 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005435 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5436 "physical device.",
5437 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5438 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005439 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005440 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5441 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5442 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5443 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005444 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005445 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5446 "VK_IMAGE_USAGE_STORAGE_BIT.",
5447 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5448 } 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 -06005449 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005450 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5451 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5452 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5453 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5454 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005455 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005456 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5457 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5458 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5459 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5460 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005461 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005462 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5463 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5464 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005465 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5466 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5467 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005468 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005469 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5470 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5471 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5472 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005473 }
5474
5475 return skip;
5476}
5477
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005478bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005479 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005480 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005481 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005482 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005483 skip |=
5484 ValidateImageUsageFlags(image_state,
5485 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5486 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005487 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5488 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5489 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005490 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005491 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005492 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005493 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005494 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005495 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005496 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005497 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005498
5499 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5500 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005501 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005502 VkFormat view_format = pCreateInfo->format;
5503 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005504 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005505 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005506
Dave Houltonbd2e2622018-04-10 16:41:14 -06005507 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005508 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005509 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005510 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005511 if (!device_extensions.vk_ext_separate_stencil_usage) {
5512 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005513 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5514 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5515 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005516 }
5517 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005518 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005519 if (image_stencil_struct == nullptr) {
5520 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005521 skip |= LogError(
5522 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005523 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5524 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5525 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5526 }
5527 } else {
5528 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5529 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5530 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005531 skip |= LogError(
5532 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005533 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5534 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5535 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5536 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5537 }
5538 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5539 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005540 skip |= LogError(
5541 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005542 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5543 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5544 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5545 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5546 }
5547 }
5548 }
5549 }
5550
Dave Houltonbd2e2622018-04-10 16:41:14 -06005551 image_usage = chained_ivuci_struct->usage;
5552 }
5553
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005554 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5555 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5556 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5557 bool foundFormat = false;
5558 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5559 if (format_list_info->pViewFormats[i] == view_format) {
5560 foundFormat = true;
5561 break;
5562 }
5563 }
5564 if (foundFormat == false) {
5565 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5566 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5567 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5568 string_VkFormat(view_format));
5569 }
5570 }
5571
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005572 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5573 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005574 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005575 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005576 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005577 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005578 std::stringstream ss;
5579 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005580 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005581 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005582 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005583 }
5584 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005585 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005586 // 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 -07005587 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5588 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5589 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5590 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005591 const char *error_vuid;
5592 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5593 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5594 } else if ((device_extensions.vk_khr_maintenance2) &&
5595 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5596 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5597 } else if ((!device_extensions.vk_khr_maintenance2) &&
5598 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5599 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5600 } else {
5601 // both enabled
5602 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5603 }
Dave Houltonc7988072018-04-16 11:46:56 -06005604 std::stringstream ss;
5605 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005606 << " is not in the same format compatibility class as "
5607 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005608 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5609 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005610 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005611 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005612 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005613 }
5614 } else {
5615 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005616 // Unless it is a multi-planar color bit aspect
5617 if ((image_format != view_format) &&
5618 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5619 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5620 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005621 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005622 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005623 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005624 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005625 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005626 }
5627 }
5628
5629 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005630 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005631
5632 switch (image_type) {
5633 case VK_IMAGE_TYPE_1D:
5634 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005635 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5636 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5637 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005638 }
5639 break;
5640 case VK_IMAGE_TYPE_2D:
5641 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5642 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5643 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005644 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5645 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5646 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005647 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005648 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5649 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5650 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005651 }
5652 }
5653 break;
5654 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005655 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005656 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5657 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005658 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005659 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005660 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5661 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5662 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005663 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5664 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005665 skip |= LogError(
5666 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5667 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5668 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5669 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5670 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005671 }
5672 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005673 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5674 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5675 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005676 }
5677 }
5678 } else {
5679 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005680 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5681 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5682 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005683 }
5684 }
5685 break;
5686 default:
5687 break;
5688 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005689
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005690 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005691 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005692 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005693 }
5694
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005695 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005696
Tobias Hector6663c9b2020-11-05 10:18:02 +00005697 if (enabled_features.shading_rate_image.shadingRateImage) {
5698 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5699 if (view_format != VK_FORMAT_R8_UINT) {
5700 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5701 "vkCreateImageView() If image was created with usage containing "
5702 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5703 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005704 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005705 }
5706
5707 if (enabled_features.shading_rate_image.shadingRateImage ||
5708 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5709 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5710 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5711 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5712 "vkCreateImageView() If image was created with usage containing "
5713 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5714 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5715 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005716 }
5717 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005718
Tobias Hector6663c9b2020-11-05 10:18:02 +00005719 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5720 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5721 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5722 pCreateInfo->subresourceRange.layerCount != 1) {
5723 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5724 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5725 pCreateInfo->subresourceRange.layerCount);
5726 }
5727
Jeff Bolz99e3f632020-03-24 22:59:22 -05005728 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5729 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5730 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5731 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5732 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5733 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5734 }
5735 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5736 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5737 skip |= LogError(
5738 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5739 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5740 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5741 }
5742 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005743
5744 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5745 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005746 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005747 "vkCreateImageView(): If image was created with usage containing "
5748 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5749 pCreateInfo->subresourceRange.levelCount);
5750 }
5751 }
5752 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5753 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005754 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005755 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5756 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5757 }
5758 } else {
5759 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5760 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5761 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005762 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005763 "vkCreateImageView(): If image was created with usage containing "
5764 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5765 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5766 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5767 }
5768 }
5769 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005770
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005771 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5772 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5773 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5774 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5775 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5776 }
5777 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5778 skip |=
5779 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5780 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5781 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5782 }
5783 }
5784 if (device_extensions.vk_ext_fragment_density_map_2) {
5785 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5786 (pCreateInfo->subresourceRange.layerCount >
5787 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5788 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5789 "vkCreateImageView(): If image was created with flags containing "
5790 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5791 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5792 pCreateInfo->subresourceRange.layerCount,
5793 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5794 }
5795 }
5796
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005797 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005798 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5799 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5800 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5801 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5802 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5803 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5804 }
5805 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005806
5807 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5808 // If swizzling is disabled, make sure it isn't used
5809 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5810 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5811 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5812 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5813 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5814 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5815 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5816 }
5817
5818 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5819 // disabled
5820 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5821 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5822 // spec. See Github issue #2361.
5823 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5824 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5825 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5826 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5827 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5828 "vkCreateImageView (portability error): ImageView format must have"
5829 " the same number of components and bits per component as the Image's format");
5830 }
5831 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005832 }
5833 return skip;
5834}
5835
Jeff Leger178b1e52020-10-05 12:22:23 -04005836template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005837bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005838 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005839 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005840 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5841 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5842 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005843
5844 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5845 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5846 VkDeviceSize src_min = UINT64_MAX;
5847 VkDeviceSize src_max = 0;
5848 VkDeviceSize dst_min = UINT64_MAX;
5849 VkDeviceSize dst_max = 0;
5850
5851 for (uint32_t i = 0; i < regionCount; i++) {
5852 src_min = std::min(src_min, pRegions[i].srcOffset);
5853 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5854 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5855 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5856
5857 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5858 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005859 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005860 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005861 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5862 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005863 }
5864
5865 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5866 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005867 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005868 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005869 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5870 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005871 }
5872
5873 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5874 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005875 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005876 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005877 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005878 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005879 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005880 }
5881
5882 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5883 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005884 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005885 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005886 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005887 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005888 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005889 }
5890 }
5891
5892 // 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 -06005893 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005894 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005895 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005896 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04005897 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005898 }
5899 }
5900
5901 return skip;
5902}
5903
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005904bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005905 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005906 const auto cb_node = GetCBState(commandBuffer);
5907 const auto src_buffer_state = GetBufferState(srcBuffer);
5908 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005909
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005910 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005911 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5912 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005913 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005914 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005915 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5916 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005917 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005918 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5919 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005920 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Jeff Leger178b1e52020-10-05 12:22:23 -04005921 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005922 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5923 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5924 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005925 return skip;
5926}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005927
Jeff Leger178b1e52020-10-05 12:22:23 -04005928bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5929 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5930 const auto cb_node = GetCBState(commandBuffer);
5931 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5932 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5933
5934 bool skip = false;
5935 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5936 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5937 // Validate that SRC & DST buffers have correct usage flags set
5938 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5939 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5940 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5941 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5942 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5943 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005944 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
Jeff Leger178b1e52020-10-05 12:22:23 -04005945 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5946 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5947 skip |=
5948 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5949 skip |=
5950 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5951 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5952 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5953 return skip;
5954}
5955
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005956bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005957 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005958 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005959 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005960 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005961 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5962 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005963 }
5964 }
5965 return skip;
5966}
5967
Jeff Bolz5c801d12019-10-09 10:38:45 -05005968bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5969 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005970 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005971
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005972 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005973 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005974 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005975 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005976 }
5977 return skip;
5978}
5979
Jeff Bolz5c801d12019-10-09 10:38:45 -05005980bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005981 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005982
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005983 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005984 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005985 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005986 }
5987 return skip;
5988}
5989
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06005990void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
5991 const auto buffer_state = Get<BUFFER_STATE>(buffer);
5992 if (buffer_state) {
5993 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
5994 if (itr != buffer_address_map_.end()) {
5995 buffer_address_map_.erase(itr);
5996 }
5997 }
5998 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
5999}
6000
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006001bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006002 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006003 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006004 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006005 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006006 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006007 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006008 }
6009 return skip;
6010}
6011
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006012bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006013 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006014 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006015 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006016 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006017 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006018 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006019 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006020 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6021 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006022
sfricke-samsung022fa252020-07-24 03:26:16 -07006023 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6024 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6025
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006026 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006027 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6028 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6029 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6030 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006031 }
6032
6033 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006034 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6035 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6036 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6037 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006038 }
6039
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006040 return skip;
6041}
6042
Jeff Leger178b1e52020-10-05 12:22:23 -04006043template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006044bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006045 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006046 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006047 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006048 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6049 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006050
sfricke-samsung125d2b42020-05-28 06:32:43 -07006051 assert(image_state != nullptr);
6052 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006053
6054 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006055 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006056 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6057 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006058 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006059 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6060 "and 1, respectively.",
6061 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006062 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006063 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006064
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006065 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6066 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006067 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006068 "%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 -07006069 "must be 0 and 1, respectively.",
6070 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006071 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006072 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006073
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006074 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6075 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006076 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006077 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006078 "For 3D images these must be 0 and 1, respectively.",
6079 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006080 }
6081 }
6082
6083 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006084 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006085 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6086 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006087
sfricke-samsung8feecc12021-01-23 03:28:38 -08006088 if (FormatIsDepthOrStencil(image_format)) {
6089 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006090 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006091 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6092 " must be a multiple 4 if using a depth/stencil format (%s).",
6093 function, i, bufferOffset, string_VkFormat(image_format));
6094 }
6095 } else {
6096 // If not depth/stencil and not multi-plane
6097 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6098 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6099 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6100 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006101 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006102 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6103 " must be a multiple of this format's texel size (%" PRIu32 ").",
6104 function, i, bufferOffset, element_size);
6105 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006106 }
6107
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006108 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6109 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006110 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006111 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006112 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006113 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006114 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006115 }
6116
6117 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6118 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006119 vuid =
6120 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006121 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006122 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006123 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6124 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006125 }
6126
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006127 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006128 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006129 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006130 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 -06006131 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6132 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006133 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006134 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006135 "zero or <= image subresource width (%d).",
6136 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006137 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006138 }
6139
6140 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006141 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 -06006142 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6143 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006144 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006145 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006146 "zero or <= image subresource height (%d).",
6147 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006148 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006149 }
6150
6151 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006152 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 -06006153 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6154 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006155 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006156 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006157 "zero or <= image subresource depth (%d).",
6158 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006159 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006160 }
6161
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006162 // subresource aspectMask must have exactly 1 bit set
6163 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006164 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006165 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006166 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006167 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006168 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006169 }
6170
6171 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006172 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006173 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006174 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006175 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6176 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006177 }
6178
6179 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006180 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6181 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006182
6183 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006184 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006185 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006186 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006187 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04006188 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006189 }
6190
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006191 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006192 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006193 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006194 image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006195 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006196 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006197 }
6198
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006199 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006200 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6201 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6202 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006203 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006204 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006205 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006206 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6207 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006208 }
6209
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006210 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006211 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006212 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006213 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006214 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Petr Krausb0d5e592021-05-21 23:37:11 +02006215 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ").",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006216 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006217 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006218
6219 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006220 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006221 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006222 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006223 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006224 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006225 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006226 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6227 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006228 }
6229
6230 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006231 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006232 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006233 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006234 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006235 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006236 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6237 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006238 }
6239
6240 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006241 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006242 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006243 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006244 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006245 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006246 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6247 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006248 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006249 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006250
6251 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006252 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006253 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006254 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006255 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006256 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006257 "format has three planes.",
6258 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006259 }
6260
6261 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006262 if (0 ==
6263 (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 -06006264 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006265 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006266 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6267 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006268 } else {
6269 // Know aspect mask is valid
6270 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6271 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006272 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006273 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006274 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006275 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006276 " 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 -08006277 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006278 string_VkFormat(compatible_format));
6279 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006280 }
6281 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006282
6283 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6284 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6285 assert(command_pool != nullptr);
6286 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6287 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6288 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006289 LogObjectList objlist(cb_node->commandBuffer());
6290 objlist.add(command_pool->commandPool());
6291 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006292 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6293 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6294 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6295 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006296 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6297 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006298 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006299 }
6300
6301 return skip;
6302}
6303
Jeff Leger178b1e52020-10-05 12:22:23 -04006304template <typename BufferImageCopyRegionType>
6305bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6306 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006307 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006308 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006309
6310 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006311 VkExtent3D extent = pRegions[i].imageExtent;
6312 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006313
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006314 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6315 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006316 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006317 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6318 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006319 }
6320
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006321 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006322
6323 // 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 -06006324 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006325 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006326 if (image_extent.width % block_extent.width) {
6327 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6328 }
6329 if (image_extent.height % block_extent.height) {
6330 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6331 }
6332 if (image_extent.depth % block_extent.depth) {
6333 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6334 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006335 }
6336
Dave Houltonfc1a4052017-04-27 14:32:45 -06006337 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006338 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006339 }
6340 }
6341
6342 return skip;
6343}
6344
Jeff Leger178b1e52020-10-05 12:22:23 -04006345template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006346bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006347 const BufferImageCopyRegionType *pRegions, const char *func_name,
6348 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006349 bool skip = false;
6350
6351 VkDeviceSize buffer_size = buff_state->createInfo.size;
6352
6353 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006354 VkDeviceSize max_buffer_offset =
6355 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6356 if (buffer_size < max_buffer_offset) {
6357 skip |=
Petr Krausb0d5e592021-05-21 23:37:11 +02006358 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 -07006359 }
6360 }
6361
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006362 return skip;
6363}
6364
Jeff Leger178b1e52020-10-05 12:22:23 -04006365template <typename BufferImageCopyRegionType>
6366bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6367 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6368 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006369 const auto cb_node = GetCBState(commandBuffer);
6370 const auto src_image_state = GetImageState(srcImage);
6371 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006372
Jeff Leger178b1e52020-10-05 12:22:23 -04006373 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6374 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6375 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6376 const char *vuid;
6377
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006378 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006379
6380 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006381 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006382
6383 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006384 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006385
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006386 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006387
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006388 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006389 vuid =
6390 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6391 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6392 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6393 "or transfer capabilities.",
6394 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006395 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006396 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6397 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6398 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6399 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006400
Jeff Leger178b1e52020-10-05 12:22:23 -04006401 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6402 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6403 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6404
6405 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6406 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6407 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6408 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006409
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006410 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006411 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6412 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006413 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006414 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6415 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006416 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006417 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6418 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6419 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6420 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6421 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6422 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006423
6424 // Validation for VK_EXT_fragment_density_map
6425 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006426 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006427 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006428 "%s: srcImage must not have been created with flags containing "
6429 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6430 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006431 }
6432
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006433 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006434 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6435 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006436 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006437 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006438
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006439 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 -04006440 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6441 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6442 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6443 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6444
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006445 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006446 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6447 vuid =
6448 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006449 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006450 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6451 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6452 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6453 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6454 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6455 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6456 "imageSubresource", vuid);
6457 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6458 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006459 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006460 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006461 }
6462 return skip;
6463}
6464
Jeff Leger178b1e52020-10-05 12:22:23 -04006465bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6466 VkBuffer dstBuffer, uint32_t regionCount,
6467 const VkBufferImageCopy *pRegions) const {
6468 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6469 COPY_COMMAND_VERSION_1);
6470}
6471
6472bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6473 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6474 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6475 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6476 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6477}
6478
John Zulauf1686f232019-07-09 16:27:11 -06006479void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6480 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6481 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6482
6483 auto cb_node = GetCBState(commandBuffer);
6484 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006485 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006486 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006487 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006488 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006489}
6490
Jeff Leger178b1e52020-10-05 12:22:23 -04006491void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6492 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6493 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6494
6495 auto cb_node = GetCBState(commandBuffer);
6496 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6497 // Make sure that all image slices record referenced layout
6498 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6499 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6500 pCopyImageToBufferInfo->srcImageLayout);
6501 }
6502}
6503
6504template <typename RegionType>
6505bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6506 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6507 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006508 const auto cb_node = GetCBState(commandBuffer);
6509 const auto src_buffer_state = GetBufferState(srcBuffer);
6510 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006511
Jeff Leger178b1e52020-10-05 12:22:23 -04006512 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6513 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6514 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6515 const char *vuid;
6516
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006517 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006518
6519 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006520 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006521
Jeff Leger178b1e52020-10-05 12:22:23 -04006522 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6523 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6524 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6525 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6526
6527 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6528 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6529 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6530 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6531 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6532 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6533 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6534 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6535 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006536 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006537 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6538 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006539 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006540 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6541 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6542 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6543 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6544 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6545 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006546
6547 // Validation for VK_EXT_fragment_density_map
6548 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006549 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006550 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006551 "%s: dstImage must not have been created with flags containing "
6552 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6553 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006554 }
6555
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006556 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006557 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6558 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006559 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006560 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006561
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006562 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 -04006563 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6564 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6565 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6566 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6567
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006568 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006569 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6570 vuid =
6571 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006572 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006573 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6574 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6575 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6576 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6577 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6578 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6579 "imageSubresource", vuid);
6580 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6581 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006582 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006583 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006584
6585 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6586 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6587 assert(command_pool != nullptr);
6588 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6589 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6590 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6591 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6592 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006593 LogObjectList objlist(cb_node->commandBuffer());
6594 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006595 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6596 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006597 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006598 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6599 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6600 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006601 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6602 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006603 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006604 }
6605 return skip;
6606}
6607
Jeff Leger178b1e52020-10-05 12:22:23 -04006608bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6609 VkImageLayout dstImageLayout, uint32_t regionCount,
6610 const VkBufferImageCopy *pRegions) const {
6611 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6612 COPY_COMMAND_VERSION_1);
6613}
6614
6615bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6616 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6617 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6618 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6619 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6620}
6621
John Zulauf1686f232019-07-09 16:27:11 -06006622void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6623 VkImageLayout dstImageLayout, uint32_t regionCount,
6624 const VkBufferImageCopy *pRegions) {
6625 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6626
6627 auto cb_node = GetCBState(commandBuffer);
6628 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006629 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006630 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006631 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006632 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006633}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006634
Jeff Leger178b1e52020-10-05 12:22:23 -04006635void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6636 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6637 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6638
6639 auto cb_node = GetCBState(commandBuffer);
6640 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6641 // Make sure that all image slices are record referenced layout
6642 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6643 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6644 pCopyBufferToImageInfo2KHR->dstImageLayout);
6645 }
6646}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006647bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006648 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006649 bool skip = false;
6650 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6651
Dave Houlton1d960ff2018-01-19 12:17:05 -07006652 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006653 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6654 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6655 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006656 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6657 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006658 }
6659
John Zulaufa26d3c82019-08-14 16:09:08 -06006660 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006661 if (!image_entry) {
6662 return skip;
6663 }
6664
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006665 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6666 if (device_extensions.vk_ext_image_drm_format_modifier) {
6667 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6668 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006669 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6670 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6671 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006672 }
6673 } else {
6674 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006675 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6676 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006677 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006678 }
6679
Dave Houlton1d960ff2018-01-19 12:17:05 -07006680 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006681 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006682 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6683 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6684 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006685 }
6686
Dave Houlton1d960ff2018-01-19 12:17:05 -07006687 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006688 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006689 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6690 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6691 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006692 }
6693
Dave Houlton1d960ff2018-01-19 12:17:05 -07006694 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006695 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006696 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6697 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006698 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006699 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6700 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006701 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006702 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6703 }
6704 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006705 skip |= LogError(image, vuid,
6706 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6707 ") must be a single-plane specifier flag.",
6708 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006709 }
6710 } else if (FormatIsColor(img_format)) {
6711 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006712 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6713 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6714 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006715 }
6716 } else if (FormatIsDepthOrStencil(img_format)) {
6717 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6718 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006719 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006720 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6721 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6722 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6723 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006724 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6725 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6726 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006727 }
6728 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006729
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006730 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006731 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006732 }
6733
Mike Weiblen672b58b2017-02-21 14:32:53 -07006734 return skip;
6735}
sfricke-samsung022fa252020-07-24 03:26:16 -07006736
6737// Validates the image is allowed to be protected
6738bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006739 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006740 bool skip = false;
6741 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006742 LogObjectList objlist(cb_state->commandBuffer());
6743 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006744 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 -06006745 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6746 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006747 }
6748 return skip;
6749}
6750
6751// Validates the image is allowed to be unprotected
6752bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006753 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006754 bool skip = false;
6755 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006756 LogObjectList objlist(cb_state->commandBuffer());
6757 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006758 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 -06006759 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6760 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006761 }
6762 return skip;
6763}
6764
6765// Validates the buffer is allowed to be protected
6766bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006767 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006768 bool skip = false;
6769 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006770 LogObjectList objlist(cb_state->commandBuffer());
6771 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006772 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 -06006773 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6774 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006775 }
6776 return skip;
6777}
6778
6779// Validates the buffer is allowed to be unprotected
6780bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006781 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006782 bool skip = false;
6783 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006784 LogObjectList objlist(cb_state->commandBuffer());
6785 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006786 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 -06006787 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6788 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006789 }
6790 return skip;
6791}