blob: 87ceb9f3626987c714a8d7224015293e31437110 [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;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001046 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001047 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001048 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001049 if (!IsTransferOp(barrier)) {
1050 return skip;
1051 }
1052 const TransferBarrier *barrier_record = nullptr;
1053 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, barrier) &&
1054 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1055 const auto found = barrier_sets.release.find(barrier);
1056 if (found != barrier_sets.release.cend()) {
1057 barrier_record = &(*found);
1058 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001059 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001060 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1061 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1062 const auto found = barrier_sets.acquire.find(barrier);
1063 if (found != barrier_sets.acquire.cend()) {
1064 barrier_record = &(*found);
1065 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001066 }
1067 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001068 if (barrier_record != nullptr) {
1069 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001070 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001071 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1072 " duplicates existing barrier recorded in this command buffer.",
1073 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1074 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1075 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001076 return skip;
1077}
1078
John Zulaufa4472282019-08-22 14:44:34 -06001079VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1080 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1081}
1082
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001083VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1084 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1085}
1086
John Zulaufa4472282019-08-22 14:44:34 -06001087const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1088 return device_state.GetImageState(barrier.image);
1089}
1090
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001091const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1092 return device_state.GetImageState(barrier.image);
1093}
1094
John Zulaufa4472282019-08-22 14:44:34 -06001095VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1096 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1097}
1098
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001099VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1100 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1101}
1102
John Zulaufa4472282019-08-22 14:44:34 -06001103const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1104 return device_state.GetBufferState(barrier.buffer);
1105}
1106
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001107const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1108 return device_state.GetBufferState(barrier.buffer);
1109}
John Zulaufa4472282019-08-22 14:44:34 -06001110
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001111template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001112void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001113 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001114 auto pool = cb_state->command_pool.get();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001115 if (IsTransferOp(barrier)) {
1116 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, barrier) &&
1117 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
1118 barrier_sets.release.emplace(barrier);
1119 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, barrier) &&
1120 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
1121 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001122 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001123 }
John Zulaufa4472282019-08-22 14:44:34 -06001124
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001125 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1126 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001127 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1128 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001129 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1130
1131 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001132 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1133 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1134 auto handle_state = BarrierHandleState(*this, barrier);
1135 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1136 if (!mode_concurrent) {
1137 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001138 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001139 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001140 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1141 const QUEUE_STATE *queue_state) {
1142 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001143 src_queue_family, dst_queue_family);
1144 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001145 }
1146 }
1147}
1148
Jeremy Gebbeneb791f32021-04-07 11:52:59 -06001149// Check if all barriers are of a given operation type.
1150template <typename Barrier, typename OpCheck>
1151bool AllTransferOp(const COMMAND_POOL_STATE *pool, OpCheck &op_check, uint32_t count, const Barrier *barriers) {
1152 if (!pool) return false;
1153
1154 for (uint32_t b = 0; b < count; b++) {
1155 if (!op_check(pool, barriers[b])) return false;
1156 }
1157 return true;
1158}
1159
1160// Look at the barriers to see if we they are all release or all acquire, the result impacts queue properties validation
1161template <typename BufBarrier, typename ImgBarrier>
1162BarrierOperationsType CoreChecks::ComputeBarrierOperationsType(const CMD_BUFFER_STATE *cb_state, uint32_t buffer_barrier_count,
1163 const BufBarrier *buffer_barriers, uint32_t image_barrier_count,
1164 const ImgBarrier *image_barriers) const {
1165 auto pool = cb_state->command_pool.get();
1166 BarrierOperationsType op_type = kGeneral;
1167
1168 // Look at the barrier details only if they exist
1169 // Note: AllTransferOp returns true for count == 0
1170 if ((buffer_barrier_count + image_barrier_count) != 0) {
1171 if (AllTransferOp(pool, TempIsReleaseOp<BufBarrier>, buffer_barrier_count, buffer_barriers) &&
1172 AllTransferOp(pool, TempIsReleaseOp<ImgBarrier>, image_barrier_count, image_barriers)) {
1173 op_type = kAllRelease;
1174 } else if (AllTransferOp(pool, IsAcquireOp<BufBarrier>, buffer_barrier_count, buffer_barriers) &&
1175 AllTransferOp(pool, IsAcquireOp<ImgBarrier>, image_barrier_count, image_barriers)) {
1176 op_type = kAllAcquire;
1177 }
1178 }
1179
1180 return op_type;
1181}
1182// explictly instantiate so these can be used in core_validation.cpp
1183template BarrierOperationsType CoreChecks::ComputeBarrierOperationsType(const CMD_BUFFER_STATE *cb_state,
1184 uint32_t buffer_barrier_count,
1185 const VkBufferMemoryBarrier *buffer_barriers,
1186 uint32_t image_barrier_count,
1187 const VkImageMemoryBarrier *image_barriers) const;
1188template BarrierOperationsType CoreChecks::ComputeBarrierOperationsType(const CMD_BUFFER_STATE *cb_state,
1189 uint32_t buffer_barrier_count,
1190 const VkBufferMemoryBarrier2KHR *buffer_barriers,
1191 uint32_t image_barrier_count,
1192 const VkImageMemoryBarrier2KHR *image_barriers) const;
1193
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001194// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001195template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001196bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001197 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1198 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001199 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1200 using sync_vuid_maps::GetImageBarrierVUID;
1201 using sync_vuid_maps::ImageError;
1202
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001203 bool skip = false;
1204 const auto *fb_state = framebuffer;
1205 assert(fb_state);
1206 const auto img_bar_image = img_barrier.image;
1207 bool image_match = false;
1208 bool sub_image_found = false; // Do we find a corresponding subpass description
1209 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1210 uint32_t attach_index = 0;
1211 // Verify that a framebuffer image matches barrier image
1212 const auto attachment_count = fb_state->createInfo.attachmentCount;
1213 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001214 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001215 if (view_state && (img_bar_image == view_state->create_info.image)) {
1216 image_match = true;
1217 attach_index = attachment;
1218 break;
1219 }
1220 }
1221 if (image_match) { // Make sure subpass is referring to matching attachment
1222 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1223 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1224 sub_image_found = true;
1225 }
1226 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1227 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1228 if (resolve && resolve->pDepthStencilResolveAttachment &&
1229 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1230 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1231 sub_image_found = true;
1232 }
1233 }
1234 if (!sub_image_found) {
1235 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1236 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1237 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1238 sub_image_found = true;
1239 break;
1240 }
1241 if (!sub_image_found && sub_desc.pResolveAttachments &&
1242 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1243 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1244 sub_image_found = true;
1245 break;
1246 }
1247 }
1248 }
1249 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001250 auto img_loc = loc.dot(Field::image);
1251 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1252 skip |=
1253 LogError(rp_handle, vuid,
1254 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1255 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1256 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001257 }
1258 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001259 auto img_loc = loc.dot(Field::image);
1260 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001261 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 -07001262 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001263 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001264 }
1265 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001266 auto layout_loc = loc.dot(Field::oldLayout);
1267 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001268 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001269 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001270 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001271 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001272 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1273 } else {
1274 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1275 LogObjectList objlist(rp_handle);
1276 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001277 auto layout_loc = loc.dot(Field::oldLayout);
1278 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1279 skip |= LogError(objlist, vuid,
1280 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001281 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001282 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001283 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1284 string_VkImageLayout(img_barrier.oldLayout));
1285 }
1286 }
1287 return skip;
1288}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001289// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001290template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001291 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1292 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1293 const VkImageMemoryBarrier &img_barrier,
1294 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001295template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001296 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1297 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1298 const VkImageMemoryBarrier2KHR &img_barrier,
1299 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001300
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001301template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001302void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001303 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001304 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1305 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1306 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1307 const auto active_subpass = cb_state->activeSubpass;
1308 const auto rp_state = cb_state->activeRenderPass;
1309 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001310 // Secondary CB case w/o FB specified delay validation
1311 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001312 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001313 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001314 cb_state->cmd_execute_commands_functions.emplace_back(
1315 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1316 const FRAMEBUFFER_STATE *fb) {
1317 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1318 render_pass, barrier, primary_cb);
1319 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001320 }
1321}
1322
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001323void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001324 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1325 const VkImageMemoryBarrier *pImageMemBarriers) {
1326 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001327 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001328 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1329 }
1330 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001331 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001332 const auto &img_barrier = pImageMemBarriers[i];
1333 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1334 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1335 }
1336}
1337
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001338void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001339 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001340 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001341 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1342 }
1343 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001344 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001345 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1346 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1347 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1348 }
1349}
1350
1351template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001352bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001353 const char *operation, const TransferBarrier &barrier,
1354 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001355 // Record to the scoreboard or report that we have a duplication
1356 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001357 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001358 if (!inserted.second && inserted.first->second != cb_state) {
1359 // 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 -06001360 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001361 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001362 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001363 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001364 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1365 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001366 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001367 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001368 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001369 }
1370 return skip;
1371}
1372
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001373template <typename TransferBarrier>
1374bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1375 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1376 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001377 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001378 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001379 const char *barrier_name = TransferBarrier::BarrierName();
1380 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001381 // No release should have an extant duplicate (WARNING)
1382 for (const auto &release : cb_barriers.release) {
1383 // Check the global pending release barriers
1384 const auto set_it = global_release_barriers.find(release.handle);
1385 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001386 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001387 const auto found = set_for_handle.find(release);
1388 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001389 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001390 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1391 " to dstQueueFamilyIndex %" PRIu32
1392 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1393 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1394 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001395 }
1396 }
1397 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1398 }
1399 // Each acquire must have a matching release (ERROR)
1400 for (const auto &acquire : cb_barriers.acquire) {
1401 const auto set_it = global_release_barriers.find(acquire.handle);
1402 bool matching_release_found = false;
1403 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001404 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001405 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1406 }
1407 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001408 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001409 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1410 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1411 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1412 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001413 }
1414 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1415 }
1416 return skip;
1417}
1418
John Zulauf3b04ebd2019-07-18 14:08:11 -06001419bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001420 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1421 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001422 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001423 skip |=
1424 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1425 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1426 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001427 return skip;
1428}
1429
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001430template <typename TransferBarrier>
1431void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1432 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001433 // Add release barriers from this submit to the global map
1434 for (const auto &release : cb_barriers.release) {
1435 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1436 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1437 global_release_barriers[release.handle].insert(release);
1438 }
1439
1440 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1441 for (const auto &acquire : cb_barriers.acquire) {
1442 // NOTE: We're not using [] because we don't want to create entries for missing releases
1443 auto set_it = global_release_barriers.find(acquire.handle);
1444 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001445 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001446 set_for_handle.erase(acquire);
1447 if (set_for_handle.size() == 0) { // Clean up empty sets
1448 global_release_barriers.erase(set_it);
1449 }
1450 }
1451 }
1452}
1453
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001454void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001455 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1456 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1457 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001458}
1459
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001460template <typename ImgBarrier>
1461void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1462 // For ownership transfers, the barrier is specified twice; as a release
1463 // operation on the yielding queue family, and as an acquire operation
1464 // on the acquiring queue family. This barrier may also include a layout
1465 // transition, which occurs 'between' the two operations. For validation
1466 // purposes it doesn't seem important which side performs the layout
1467 // transition, but it must not be performed twice. We'll arbitrarily
1468 // choose to perform it as part of the acquire operation.
1469 //
1470 // However, we still need to record initial layout for the "initial layout" validation
1471 for (uint32_t i = 0; i < barrier_count; i++) {
1472 const auto &mem_barrier = barriers[i];
John Zulauf2be3fe02019-12-30 09:48:02 -07001473 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001474 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001475 if (image_state) {
1476 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1477 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001478 }
1479}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001480// explictly instantiate this template so it can be used in core_validation.cpp
1481template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1482 const VkImageMemoryBarrier *barrier);
1483template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1484 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001485
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001486VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1487
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001488template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001489void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001490 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001491 if (enabled_features.synchronization2_features.synchronization2) {
1492 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1493 return;
1494 }
1495 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001496 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001497 const auto &image_create_info = image_state->createInfo;
1498
Mike Schuchardt2df08912020-12-15 16:28:09 -08001499 // 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 -07001500 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001501 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001502 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001503 normalized_isr.baseArrayLayer = 0;
1504 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1505 }
1506
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001507 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1508 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001509
1510 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001511 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001512 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1513 }
1514
John Zulauf2be3fe02019-12-30 09:48:02 -07001515 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001516 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001517 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001518 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001519 }
unknown86bcb3a2019-07-11 13:05:36 -06001520}
1521
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001522bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1523 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1524 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1525 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001526 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001527 assert(cb_node);
1528 assert(image_state);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001529 const auto image = image_state->image();
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001530 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001531
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001532 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image);
John Zulauff660ad62019-03-23 07:16:05 -06001533 if (subresource_map) {
1534 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001535 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001536 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1537 // the next "constant value" range
1538 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001539 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001540 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001541 subres_skip |= LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001542 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1543 "%s layout %s.",
1544 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1545 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1546 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001547 }
John Zulauf5e617452019-11-19 14:44:16 -07001548 }
John Zulauff660ad62019-03-23 07:16:05 -06001549 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001550 }
John Zulauff660ad62019-03-23 07:16:05 -06001551
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001552 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1553 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1554 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001555 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1556 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001557 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001558 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1559 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001560 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001561 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001562 if (image_state->shared_presentable) {
1563 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001564 skip |=
1565 LogError(device, layout_invalid_msg_code,
1566 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1567 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001568 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001569 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001570 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001571 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001572 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001573 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1574 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1575 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001576 }
1577 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001578 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001579}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001580bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001581 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1582 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001583 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001584 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1585 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1586}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001587
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001588void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001589 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001590 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1591 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001592
Mike Schuchardt2df08912020-12-15 16:28:09 -08001593 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001594 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001595 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001596 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001597 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001598 VkImageLayout stencil_layout = kInvalidLayout;
1599 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001600 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001601 if (attachment_description_stencil_layout) {
1602 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1603 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001604 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001605 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001606 }
1607 }
1608}
Dave Houltone19e20d2018-02-02 16:32:41 -07001609
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001610#ifdef VK_USE_PLATFORM_ANDROID_KHR
1611// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1612// This could also move into a seperate core_validation_android.cpp file... ?
1613
1614//
1615// AHB-specific validation within non-AHB APIs
1616//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001617bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001618 bool skip = false;
1619
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001620 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001621 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001622 if (0 != ext_fmt_android->externalFormat) {
1623 if (VK_FORMAT_UNDEFINED != create_info->format) {
1624 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001625 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1626 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1627 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001628 }
1629
1630 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001631 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1632 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1633 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001634 }
1635
1636 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001637 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1638 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001639 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001640 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001641 }
1642
1643 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001644 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1645 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1646 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001647 }
1648 }
1649
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001650 if ((0 != ext_fmt_android->externalFormat) &&
1651 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001652 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001653 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1654 ") which has "
1655 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1656 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001657 }
1658 }
1659
Dave Houltond9611312018-11-19 17:03:36 -07001660 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001661 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001662 skip |=
1663 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1664 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1665 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001666 }
1667 }
1668
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001669 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001670 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1671 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001672 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001673 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1674 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1675 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1676 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001677 }
1678
1679 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001680 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1681 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1682 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1683 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1684 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001685 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001686 }
1687
1688 return skip;
1689}
1690
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001691bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001692 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001693 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001694
1695 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001696 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001697 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1698 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001699 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001700 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001701 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001702
Dave Houltond9611312018-11-19 17:03:36 -07001703 // Chain must include a compatible ycbcr conversion
1704 bool conv_found = false;
1705 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001706 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001707 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001708 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001709 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001710 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001711 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001712 }
Dave Houltond9611312018-11-19 17:03:36 -07001713 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001714 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001715 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001716 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1717 "an externalFormat (%" PRIu64
1718 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1719 "with the same external format.",
1720 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001721 }
1722
1723 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001724 if (IsIdentitySwizzle(create_info->components) == false) {
1725 skip |= LogError(
1726 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1727 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1728 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1729 "= %s.",
1730 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1731 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001732 }
1733 }
Dave Houltond9611312018-11-19 17:03:36 -07001734
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001735 return skip;
1736}
1737
John Zulaufa26d3c82019-08-14 16:09:08 -06001738bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001739 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001740
John Zulaufa26d3c82019-08-14 16:09:08 -06001741 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001742 if (image_state != nullptr) {
1743 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1744 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1745 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1746 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1747 "bound to memory.");
1748 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001749 }
1750 return skip;
1751}
1752
1753#else
1754
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001755bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001756 return false;
1757}
1758
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001759bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001760
John Zulaufa26d3c82019-08-14 16:09:08 -06001761bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001762
1763#endif // VK_USE_PLATFORM_ANDROID_KHR
1764
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001765bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1766 bool skip = false;
1767
1768 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1769 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1770 const VkImageTiling image_tiling = pCreateInfo->tiling;
1771 const VkFormat image_format = pCreateInfo->format;
1772
1773 if (image_format == VK_FORMAT_UNDEFINED) {
1774 // VU 01975 states format can't be undefined unless an android externalFormat
1775#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001776 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001777 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1778 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1779 if (it != ahb_ext_formats_map.end()) {
1780 tiling_features = it->second;
1781 }
1782 }
1783#endif
1784 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1785 uint64_t drm_format_modifier = 0;
1786 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001787 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001788 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001789 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001790
1791 if (drm_explicit != nullptr) {
1792 drm_format_modifier = drm_explicit->drmFormatModifier;
1793 } else {
1794 // VUID 02261 makes sure its only explict or implict in parameter checking
1795 assert(drm_implicit != nullptr);
1796 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1797 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1798 }
1799 }
1800
1801 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1802 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1803 nullptr};
1804 format_properties_2.pNext = (void *)&drm_properties_list;
1805 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001806 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1807 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1808 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1809 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001810
1811 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1812 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1813 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1814 }
1815 }
1816 } else {
1817 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1818 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1819 : format_properties.optimalTilingFeatures;
1820 }
1821
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001822 // Lack of disjoint format feature support while using the flag
1823 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1824 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1825 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1826 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1827 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1828 string_VkFormat(pCreateInfo->format));
1829 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001830
1831 return skip;
1832}
1833
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001834bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001835 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001836 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001837
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001838 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001839 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001840 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1841 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001842 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1843 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001844 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001845 }
1846
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001847 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1848 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001849 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1850 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1851 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001852 }
1853
1854 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001855 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1856 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1857 "height (%d) and arrayLayers (%d) must be >= 6.",
1858 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001859 }
Dave Houlton130c0212018-01-29 13:39:56 -07001860 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001861
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001862 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001863 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1864 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1865 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001866 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001867 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1868 "device maxFramebufferWidth (%u).",
1869 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001870 }
1871
1872 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001873 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001874 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1875 "device maxFramebufferHeight (%u).",
1876 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001877 }
1878
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001879 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001880 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1881 static_cast<float>(device_limits->maxFramebufferWidth) /
1882 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001883 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1884 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001885 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1886 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1887 "ceiling of device "
1888 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1889 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1890 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001891 }
1892
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001893 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1894 static_cast<float>(device_limits->maxFramebufferHeight) /
1895 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001896 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1897 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001898 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1899 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1900 "ceiling of device "
1901 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1902 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1903 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001904 }
1905 }
1906
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001907 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001908 VkResult result = VK_SUCCESS;
1909 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1910 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1911 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1912 &format_limits);
1913 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001914 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1915 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001916 if (modifier_list) {
1917 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001918 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001919 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001920 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001921 image_format_info.type = pCreateInfo->imageType;
1922 image_format_info.format = pCreateInfo->format;
1923 image_format_info.tiling = pCreateInfo->tiling;
1924 image_format_info.usage = pCreateInfo->usage;
1925 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001926 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001927
1928 result =
1929 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1930 format_limits = image_format_properties.imageFormatProperties;
1931
1932 /* The application gives a list of modifier and the driver
1933 * selects one. If one is wrong, stop there.
1934 */
1935 if (result != VK_SUCCESS) break;
1936 }
1937 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001938 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001939 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001940 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001941 image_format_info.type = pCreateInfo->imageType;
1942 image_format_info.format = pCreateInfo->format;
1943 image_format_info.tiling = pCreateInfo->tiling;
1944 image_format_info.usage = pCreateInfo->usage;
1945 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001946 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001947
1948 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1949 format_limits = image_format_properties.imageFormatProperties;
1950 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001951 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001952
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001953 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1954 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1955 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1956 if (result != VK_SUCCESS) {
1957 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001958#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001959 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001960#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001961 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001962 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001963 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1964 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001965#ifdef VK_USE_PLATFORM_ANDROID_KHR
1966 }
1967#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001968 } else {
1969 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1970 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001971 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1972 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1973 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001974 }
Dave Houlton130c0212018-01-29 13:39:56 -07001975
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001976 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1977 static_cast<uint64_t>(pCreateInfo->extent.height) *
1978 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1979 static_cast<uint64_t>(pCreateInfo->samples);
1980 uint64_t total_size =
1981 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07001982
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001983 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001984 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1985 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001986 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001987
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001988 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001989 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1990 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1991 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1992 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001993 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001994
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001995 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001996 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1997 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1998 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001999 }
2000
2001 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002002 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2003 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2004 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002005 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002006
2007 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2008 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2009 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2010 pCreateInfo->extent.width, format_limits.maxExtent.width);
2011 }
2012
2013 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2014 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2015 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2016 pCreateInfo->extent.height, format_limits.maxExtent.height);
2017 }
2018
2019 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2020 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2021 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2022 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2023 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002024 }
2025
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002026 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08002027 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
2028 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
2029 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
2030 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002031 skip |= LogError(device, error_vuid,
2032 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
2033 "YCbCr Conversion format, arrayLayers must be 1",
2034 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002035 }
2036
2037 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002038 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
2039 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
2040 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08002041 }
2042
2043 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002044 skip |= LogError(
2045 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08002046 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2047 string_VkSampleCountFlagBits(pCreateInfo->samples));
2048 }
2049
2050 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002051 skip |= LogError(
2052 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002053 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2054 string_VkImageType(pCreateInfo->imageType));
2055 }
2056 }
2057
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002058 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002059 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002060 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002061 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002062 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2063 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2064 "format must be block, ETC or ASTC compressed, but is %s",
2065 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002066 }
2067 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002068 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2069 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2070 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002071 }
2072 }
2073 }
2074
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002075 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002076 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2077 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2078 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002079 }
2080
unknown2c877272019-07-11 12:56:50 -06002081 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2082 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2083 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002084 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2085 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2086 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002087 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002088
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002089 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002090 if (swapchain_create_info != nullptr) {
2091 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2092 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2093 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2094
2095 // Validate rest of Swapchain Image create check that require swapchain state
2096 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2097 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2098 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2099 skip |= LogError(
2100 device, vuid,
2101 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2102 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2103 }
2104 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2105 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2106 skip |= LogError(device, vuid,
2107 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2108 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2109 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002110 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002111 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2112 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2113 skip |= LogError(device, vuid,
2114 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2115 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002116 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002117 }
2118 }
2119 }
2120
sfricke-samsungedce77a2020-07-03 22:35:13 -07002121 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2122 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2123 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2124 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2125 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2126 }
2127 const VkImageCreateFlags invalid_flags =
2128 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2129 if ((pCreateInfo->flags & invalid_flags) != 0) {
2130 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2131 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2132 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2133 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2134 }
2135 }
2136
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002137 skip |= ValidateImageFormatFeatures(pCreateInfo);
2138
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002139 // Check compatibility with VK_KHR_portability_subset
2140 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2141 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2142 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2143 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2144 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2145 }
2146 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2147 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2148 skip |=
2149 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2150 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2151 }
2152 }
2153
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002154 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002155}
2156
John Zulauf7eeb6f72019-06-17 11:56:36 -06002157void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2158 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2159 if (VK_SUCCESS != result) return;
2160
2161 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002162 auto image_state = Get<IMAGE_STATE>(*pImage);
2163 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002164}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002165
Jeff Bolz5c801d12019-10-09 10:38:45 -05002166bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002167 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002168 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002169 if (image_state) {
sfricke-samsung9056cc12021-04-18 22:51:00 -07002170 if (image_state->is_swapchain_image) {
2171 // TODO - Add VUID when headers are upstreamed
2172 skip |= LogError(device, "UNASSIGNED-vkDestroyImage-image",
2173 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2174 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002175 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002176 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002177 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002178 }
2179 return skip;
2180}
2181
John Zulauf7eeb6f72019-06-17 11:56:36 -06002182void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2183 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002184 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002185
locke-lunargcba7d5f2019-12-30 16:59:11 -07002186 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002187
2188 // Clean up generic image state
2189 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002190}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002191
sfricke-samsungcd924d92020-05-20 23:51:17 -07002192bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2193 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002194 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002195 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002196 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002197
2198 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002199 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2200 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002201 }
2202
sfricke-samsungcd924d92020-05-20 23:51:17 -07002203 if (FormatIsDepthOrStencil(format)) {
2204 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2205 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2206 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2207 } else if (FormatIsCompressed(format)) {
2208 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2209 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2210 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002211 }
2212
2213 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002214 skip |=
2215 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2216 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2217 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002218 }
2219 return skip;
2220}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002221
John Zulauf07288512019-07-05 11:09:50 -06002222bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2223 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2224 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002225 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002226 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2227 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002228 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002229 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2230 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002231 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002232
2233 } else {
2234 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2235 if (!device_extensions.vk_khr_shared_presentable_image) {
2236 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002237 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002238 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2239 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002240 }
2241 } else {
2242 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2243 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002244 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002245 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002246 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2247 func_name, string_VkImageLayout(dest_image_layout));
2248 }
2249 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002250 }
2251
John Zulauff660ad62019-03-23 07:16:05 -06002252 // Cast to const to prevent creation at validate time.
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002253 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state->image());
John Zulauff660ad62019-03-23 07:16:05 -06002254 if (subresource_map) {
2255 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002256 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002257 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002258 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2259 // the next "constant value" range
2260 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002261 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002262 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2263 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2264 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2265 } else {
2266 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002267 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002268 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002269 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2270 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2271 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002272 }
John Zulauf5e617452019-11-19 14:44:16 -07002273 }
John Zulauff660ad62019-03-23 07:16:05 -06002274 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002275 }
2276
2277 return skip;
2278}
2279
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002280bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2281 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002282 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002283 bool skip = false;
2284 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002285 const auto *cb_node = GetCBState(commandBuffer);
2286 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002287 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002288 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002289 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002290 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002291 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2292 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002293 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002294 skip |=
2295 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2296 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2297 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002298 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002299 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002300 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002301 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002302 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002303 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002304 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2305 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2306 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2307 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2308 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2309 string_VkFormat(image_state->createInfo.format));
2310 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002311 }
2312 return skip;
2313}
2314
John Zulaufeabb4462019-07-05 14:13:03 -06002315void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2316 const VkClearColorValue *pColor, uint32_t rangeCount,
2317 const VkImageSubresourceRange *pRanges) {
2318 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2319
2320 auto cb_node = GetCBState(commandBuffer);
2321 auto image_state = GetImageState(image);
2322 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002323 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002324 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002325 }
2326 }
2327}
2328
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002329bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2330 const char *apiName) const {
2331 bool skip = false;
2332
2333 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2334 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2335 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2336 // Also VUID-VkClearDepthStencilValue-depth-00022
2337 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2338 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2339 "(=%f) is not within the [0.0, 1.0] range.",
2340 apiName, clearValue.depth);
2341 }
2342 }
2343
2344 return skip;
2345}
2346
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002347bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2348 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002349 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002350 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002351
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002352 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002353 const auto *cb_node = GetCBState(commandBuffer);
2354 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002355 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002356 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002357 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002358 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002359 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002360 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002361 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002362 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002363 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002364 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002365 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2366 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2367 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2368 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002369
2370 bool any_include_aspect_depth_bit = false;
2371 bool any_include_aspect_stencil_bit = false;
2372
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002373 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002374 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002375 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002376 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002377 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002378 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2379 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002380 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2381 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2382 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2383 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002384 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002385 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2386 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002387 if (FormatHasDepth(image_format) == false) {
2388 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2389 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2390 "doesn't have a depth component.",
2391 i, string_VkFormat(image_format));
2392 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002393 }
2394 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2395 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002396 if (FormatHasStencil(image_format) == false) {
2397 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2398 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2399 "%s doesn't have a stencil component.",
2400 i, string_VkFormat(image_format));
2401 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002402 }
2403 }
2404 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002405 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002406 if (image_stencil_struct != nullptr) {
2407 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2408 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002409 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2410 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2411 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2412 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002413 }
2414 } else {
2415 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002416 skip |= LogError(
2417 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002418 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2419 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2420 "in VkImageCreateInfo::usage used to create image");
2421 }
2422 }
2423 }
2424 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002425 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2426 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2427 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002428 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002429 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002430 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2431 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002432 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002433 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002434 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002435 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2436 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2437 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2438 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002439 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002440 }
2441 return skip;
2442}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002443
John Zulaufeabb4462019-07-05 14:13:03 -06002444void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2445 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2446 const VkImageSubresourceRange *pRanges) {
2447 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2448 auto cb_node = GetCBState(commandBuffer);
2449 auto image_state = GetImageState(image);
2450 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002451 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002452 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002453 }
2454 }
2455}
2456
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002457// Returns true if [x, xoffset] and [y, yoffset] overlap
2458static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2459 bool result = false;
2460 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2461 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2462
2463 if (intersection_max > intersection_min) {
2464 result = true;
2465 }
2466 return result;
2467}
2468
Jeff Leger178b1e52020-10-05 12:22:23 -04002469// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002470// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002471template <typename RegionType>
2472static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002473 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002474
Dave Houltonc991cc92018-03-06 11:08:51 -07002475 // Separate planes within a multiplane image cannot intersect
2476 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002477 return result;
2478 }
2479
Dave Houltonc991cc92018-03-06 11:08:51 -07002480 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2481 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2482 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002483 result = true;
2484 switch (type) {
2485 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002486 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002487 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002488 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002489 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002490 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002491 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002492 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002493 break;
2494 default:
2495 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2496 assert(false);
2497 }
2498 }
2499 return result;
2500}
2501
Dave Houltonfc1a4052017-04-27 14:32:45 -06002502// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002503static const uint32_t kXBit = 1;
2504static const uint32_t kYBit = 2;
2505static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002506static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002507 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002508 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002509 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2510 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002511 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002512 }
2513 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2514 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002515 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002516 }
2517 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2518 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002519 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002520 }
2521 return result;
2522}
2523
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002524// Test if two VkExtent3D structs are equivalent
2525static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2526 bool result = true;
2527 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2528 (extent->depth != other_extent->depth)) {
2529 result = false;
2530 }
2531 return result;
2532}
2533
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002534// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002535static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002536 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2537}
2538
2539// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002540VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002541 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2542 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002543 auto pool = cb_node->command_pool.get();
2544 if (pool) {
2545 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002546 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002547 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002548 granularity.width *= block_size.width;
2549 granularity.height *= block_size.height;
2550 }
2551 }
2552 return granularity;
2553}
2554
2555// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2556static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2557 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002558 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2559 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002560 valid = false;
2561 }
2562 return valid;
2563}
2564
2565// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002566bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002567 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002568 bool skip = false;
2569 VkExtent3D offset_extent = {};
2570 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2571 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2572 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002573 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002574 // 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 -07002575 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002576 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002577 "%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 "
2578 "image transfer granularity is (w=0, h=0, d=0).",
2579 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002580 }
2581 } else {
2582 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2583 // integer multiples of the image transfer granularity.
2584 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002585 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002586 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2587 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2588 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2589 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002590 }
2591 }
2592 return skip;
2593}
2594
2595// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002596bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002597 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002598 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002599 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002600 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002601 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2602 // subresource extent.
2603 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002604 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002605 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2606 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2607 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2608 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002609 }
2610 } else {
2611 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2612 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2613 // subresource extent dimensions.
2614 VkExtent3D offset_extent_sum = {};
2615 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2616 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2617 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002618 bool x_ok = true;
2619 bool y_ok = true;
2620 bool z_ok = true;
2621 switch (image_type) {
2622 case VK_IMAGE_TYPE_3D:
2623 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2624 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002625 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002626 case VK_IMAGE_TYPE_2D:
2627 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2628 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002629 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002630 case VK_IMAGE_TYPE_1D:
2631 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2632 (subresource_extent->width == offset_extent_sum.width));
2633 break;
2634 default:
2635 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2636 assert(false);
2637 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002638 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002639 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002640 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002641 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2642 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2643 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2644 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2645 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2646 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002647 }
2648 }
2649 return skip;
2650}
2651
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002652bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002653 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002654 bool skip = false;
2655 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002656 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2657 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002658 }
2659 return skip;
2660}
2661
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002662bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002663 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002664 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002665 bool skip = false;
2666 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2667 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002668 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002669 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2670 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002671 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002672 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002673 }
2674 return skip;
2675}
2676
Jeff Leger178b1e52020-10-05 12:22:23 -04002677// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2678template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002679bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002680 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002681 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002682 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002683 VkExtent3D granularity = GetScaledItg(cb_node, img);
2684 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002685 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002686 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002687 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002688 return skip;
2689}
2690
Jeff Leger178b1e52020-10-05 12:22:23 -04002691// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2692template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002693bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002694 const IMAGE_STATE *dst_img, const RegionType *region,
2695 const uint32_t i, const char *function,
2696 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002697 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002698 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2699 const char *vuid;
2700
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002701 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002702 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002703 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2704 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002705 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002706 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002707 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002708 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002709 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002710
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002711 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002712 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002713 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2714 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002715 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002716 const VkExtent3D dest_effective_extent =
2717 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002718 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002719 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002720 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002721 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002722 return skip;
2723}
2724
Jeff Leger178b1e52020-10-05 12:22:23 -04002725// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2726template <typename ImageCopyRegionType>
2727bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2728 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2729 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002730 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002731 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2732 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2733 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002734
2735 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002736 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002737
2738 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002739 const VkExtent3D src_copy_extent = region.extent;
2740 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002741 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2742
Dave Houlton6f9059e2017-05-02 17:15:13 -06002743 bool slice_override = false;
2744 uint32_t depth_slices = 0;
2745
2746 // Special case for copying between a 1D/2D array and a 3D image
2747 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2748 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002749 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002750 slice_override = (depth_slices != 1);
2751 } 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 -07002752 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002753 slice_override = (depth_slices != 1);
2754 }
2755
2756 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002757 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002758 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002759 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002760 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002761 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2762 "be 0 and 1, respectively.",
2763 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002764 }
2765 }
2766
Dave Houlton533be9f2018-03-26 17:08:30 -06002767 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 -04002768 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002769 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002770 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002771 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002772 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002773 }
2774
Dave Houlton533be9f2018-03-26 17:08:30 -06002775 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002776 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002777 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 -04002778 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002779 }
2780
Dave Houltonc991cc92018-03-06 11:08:51 -07002781 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002782 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002783 if (FormatIsCompressed(src_state->createInfo.format) ||
2784 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002785 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002786 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002787 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2788 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2789 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002790 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002791 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002792 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002793 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002794 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002795 }
2796
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002797 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002798 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2799 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002800 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002801 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002802 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2803 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2804 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002805 }
2806
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002807 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002808 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2809 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002810 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
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] extent height (%d) must be a multiple of the compressed texture block "
2813 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2814 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002815 }
2816
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002817 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002818 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2819 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002820 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002821 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002822 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2823 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2824 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002825 }
2826 } // Compressed
2827
2828 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002829 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002830 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002831 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002832 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002833 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002834 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002835 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002836 }
2837 }
2838
Dave Houlton533be9f2018-03-26 17:08:30 -06002839 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 -04002840 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002841 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002842 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2843 "and 1, respectively.",
2844 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002845 }
2846
Dave Houlton533be9f2018-03-26 17:08:30 -06002847 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002848 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002849 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 -04002850 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002851 }
2852
sfricke-samsung30b094c2020-05-30 11:42:11 -07002853 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002854 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002855 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2856 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002857 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002858 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002859 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2860 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2861 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002862 }
2863 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002864 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002865 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002866 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
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] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2869 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2870 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002871 }
2872 }
2873 } else { // Pre maint 1
2874 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002875 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002876 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002877 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002878 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002879 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2880 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002881 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002882 }
Dave Houltonee281a52017-12-08 13:51:02 -07002883 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002884 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002885 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002886 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002887 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2888 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002889 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002890 }
2891 }
2892 }
2893
Dave Houltonc991cc92018-03-06 11:08:51 -07002894 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2895 if (FormatIsCompressed(dst_state->createInfo.format) ||
2896 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002897 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002898
2899 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002900 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2901 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2902 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002903 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002904 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002905 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002906 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002907 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002908 }
2909
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002910 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002911 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2912 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002913 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002914 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002915 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2916 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2917 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002918 }
2919
Dave Houltonee281a52017-12-08 13:51:02 -07002920 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2921 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2922 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002923 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002924 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002925 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002926 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2927 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002928 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002929 }
2930
Dave Houltonee281a52017-12-08 13:51:02 -07002931 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2932 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2933 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002934 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002935 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002936 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2937 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2938 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002939 }
2940 } // Compressed
2941 }
2942 return skip;
2943}
2944
Jeff Leger178b1e52020-10-05 12:22:23 -04002945template <typename RegionType>
2946bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2947 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2948 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002949 const auto *cb_node = GetCBState(commandBuffer);
2950 const auto *src_image_state = GetImageState(srcImage);
2951 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002952 const VkFormat src_format = src_image_state->createInfo.format;
2953 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002954 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002955 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002956
Jeff Leger178b1e52020-10-05 12:22:23 -04002957 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2958 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2959 const char *vuid;
2960
2961 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002962
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002963 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002964
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002965 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002966 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002967
2968 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2969 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002970 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002971
Dave Houlton6f9059e2017-05-02 17:15:13 -06002972 bool slice_override = false;
2973 uint32_t depth_slices = 0;
2974
2975 // Special case for copying between a 1D/2D array and a 3D image
2976 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2977 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2978 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002979 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002980 slice_override = (depth_slices != 1);
2981 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2982 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002983 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002984 slice_override = (depth_slices != 1);
2985 }
2986
Jeff Leger178b1e52020-10-05 12:22:23 -04002987 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2988 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2989 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2990 skip |=
2991 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2992 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2993 skip |=
2994 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2995 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002996 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002997 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2998 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002999 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003000 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003001
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003002 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003003 // No chance of mismatch if we're overriding depth slice count
3004 if (!slice_override) {
3005 // The number of depth slices in srcSubresource and dstSubresource must match
3006 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3007 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003008 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3009 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003010 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003011 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3012 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003013 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003014 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
3015 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003016 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3017 "do not match.",
3018 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003019 }
3020 }
3021 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003022 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003023 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003024 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003025 skip |=
3026 LogError(command_buffer, vuid,
3027 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3028 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003029 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003030 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003031
Dave Houltonc991cc92018-03-06 11:08:51 -07003032 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003033 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003034 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3035 // If neither image is multi-plane the aspectMask member of src and dst must match
3036 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
3037 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
3038 skip |= LogError(command_buffer, vuid,
3039 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3040 "source (0x%x) destination (0x%x).",
3041 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3042 }
3043 } else {
3044 // Source image multiplane checks
3045 uint32_t planes = FormatPlaneCount(src_format);
3046 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3047 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3048 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
3049 skip |= LogError(command_buffer, vuid,
3050 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3051 i, aspect);
3052 }
3053 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3054 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3055 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3056 skip |= LogError(command_buffer, vuid,
3057 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3058 i, aspect);
3059 }
3060 // Single-plane to multi-plane
3061 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3062 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3063 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3064 skip |= LogError(command_buffer, vuid,
3065 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3066 func_name, i, aspect);
3067 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003068
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003069 // Dest image multiplane checks
3070 planes = FormatPlaneCount(dst_format);
3071 aspect = region.dstSubresource.aspectMask;
3072 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3073 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3074 skip |= LogError(command_buffer, vuid,
3075 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3076 i, aspect);
3077 }
3078 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3079 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3080 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3081 skip |= LogError(command_buffer, vuid,
3082 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3083 i, aspect);
3084 }
3085 // Multi-plane to single-plane
3086 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3087 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3088 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3089 skip |= LogError(command_buffer, vuid,
3090 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3091 func_name, i, aspect);
3092 }
3093 }
3094 } else {
3095 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003096 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3097 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003098 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003099 skip |= LogError(
3100 command_buffer, vuid,
3101 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3102 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003103 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003104 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003105
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003106 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003107 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003108 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003109 skip |=
3110 LogError(command_buffer, vuid,
3111 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3112 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003113 }
3114
3115 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003116 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003117 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003118 skip |= LogError(
3119 command_buffer, vuid,
3120 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3121 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003122 }
3123
Dave Houltonfc1a4052017-04-27 14:32:45 -06003124 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003125 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003126 if (slice_override) src_copy_extent.depth = depth_slices;
3127 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003128 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003129 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3130 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003131 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003132 "width [%1d].",
3133 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003134 }
3135
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003136 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003137 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3138 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003139 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003140 "height [%1d].",
3141 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003142 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003143 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003144 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3145 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003146 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003147 "depth [%1d].",
3148 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003149 }
3150
Dave Houltonee281a52017-12-08 13:51:02 -07003151 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003152 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003153 if (slice_override) dst_copy_extent.depth = depth_slices;
3154
3155 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003156 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003157 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3158 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003159 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003160 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003161 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003162 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003163 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003164 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3165 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003166 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003167 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003168 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003169 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003170 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003171 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3172 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003173 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003174 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003175 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003176 }
3177
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003178 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3179 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003180 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003181 for (uint32_t j = 0; j < regionCount; j++) {
3182 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003183 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003185 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003186 }
3187 }
3188 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003189
3190 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3191 if (device_extensions.vk_khr_maintenance1) {
3192 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3193 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3194 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003195 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3196 skip |= LogError(command_buffer, vuid,
3197 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3198 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003199 }
3200 } else {
3201 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3202 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3203 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003204 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3205 skip |= LogError(command_buffer, vuid,
3206 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3207 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003208 }
3209 }
3210
3211 // Check if 2D with 3D and depth not equal to 2D layerCount
3212 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3213 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3214 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003215 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3216 skip |= LogError(command_buffer, vuid,
3217 "%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 -08003218 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003219 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003220 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3221 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3222 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003223 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3224 skip |= LogError(command_buffer, vuid,
3225 "%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 -08003226 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003227 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003228 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003229
3230 // Check for multi-plane format compatiblity
3231 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3232 size_t src_format_size = 0;
3233 size_t dst_format_size = 0;
3234 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003235 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3236 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003237 } else {
3238 src_format_size = FormatElementSize(src_format);
3239 }
3240 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003241 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3242 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003243 } else {
3244 dst_format_size = FormatElementSize(dst_format);
3245 }
3246 // If size is still zero, then format is invalid and will be caught in another VU
3247 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003248 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3249 skip |= LogError(command_buffer, vuid,
3250 "%s: pRegions[%u] called with non-compatible image formats. "
3251 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3252 func_name, i, string_VkFormat(src_format),
3253 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3254 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003255 }
3256 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003257 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003258
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003259 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3260 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3261 // because because both texels are 4 bytes in size.
3262 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003263 const char *compatible_vuid =
3264 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3265 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3266 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003267 // Depth/stencil formats must match exactly.
3268 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3269 if (src_format != dst_format) {
3270 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003271 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003272 string_VkFormat(src_format), string_VkFormat(dst_format));
3273 }
3274 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003275 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003276 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003277 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003278 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003279 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003280 FormatElementSize(dst_format));
3281 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003282 }
3283 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003284
Dave Houlton33c22b72017-02-28 13:16:02 -07003285 // Source and dest image sample counts must match
3286 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003287 std::stringstream ss;
3288 ss << func_name << " called on image pair with non-identical sample counts.";
3289 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003290 skip |=
3291 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3292 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3293 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003294 }
3295
Tony-LunarG5a066372021-01-21 10:31:34 -07003296 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3297 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3298 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003299 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003300 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3301 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3302 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3303 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003304 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003305 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3306 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3307 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3308 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3309 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3310 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3311 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3312 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3313 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3314 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3315 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3316 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003317
3318 // Validation for VK_EXT_fragment_density_map
3319 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003320 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3321 skip |=
3322 LogError(command_buffer, vuid,
3323 "%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 +02003324 }
3325 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003326 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3327 skip |=
3328 LogError(command_buffer, vuid,
3329 "%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 +02003330 }
3331
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003332 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003333 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3334 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3335 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3336 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003337 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003338 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003339 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003340
3341 const char *invalid_src_layout_vuid =
3342 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3343 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3344 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3345 const char *invalid_dst_layout_vuid =
3346 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3347 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3348 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3349
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003350 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003351 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003352 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003353 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3354 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003355 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003356 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003357 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003358 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003359 }
3360
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003361 return skip;
3362}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003363
Jeff Leger178b1e52020-10-05 12:22:23 -04003364bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3365 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3366 const VkImageCopy *pRegions) const {
3367 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3368 COPY_COMMAND_VERSION_1);
3369}
3370
3371bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3372 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3373 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3374 COPY_COMMAND_VERSION_2);
3375}
3376
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003377void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3378 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3379 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003380 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3381 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003382 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003383 auto src_image_state = GetImageState(srcImage);
3384 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003385
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003386 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003387 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003388 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3389 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003390 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003391}
3392
Jeff Leger178b1e52020-10-05 12:22:23 -04003393void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3394 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3395 auto cb_node = GetCBState(commandBuffer);
3396 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3397 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3398
3399 // Make sure that all image slices are updated to correct layout
3400 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3401 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3402 pCopyImageInfo->srcImageLayout);
3403 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3404 pCopyImageInfo->dstImageLayout);
3405 }
3406}
3407
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003408// Returns true if sub_rect is entirely contained within rect
3409static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3410 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 -07003411 (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 -07003412 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003413 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003414 return true;
3415}
3416
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003417bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003418 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003419 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3420 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003421 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003422 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3423 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003424 if (primary_cb_state) {
3425 image_view_state = primary_cb_state->GetActiveAttachmentImageViewState(fb_attachment);
3426 } else {
3427 image_view_state = GetCBState(command_buffer)->GetActiveAttachmentImageViewState(fb_attachment);
3428 }
John Zulauff2582972019-02-09 14:53:30 -07003429 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003430
3431 for (uint32_t j = 0; j < rect_count; j++) {
3432 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003433 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3434 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3435 "the current render pass instance.",
3436 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003437 }
3438
3439 if (image_view_state) {
3440 // The layers specified by a given element of pRects must be contained within every attachment that
3441 // pAttachments refers to
3442 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3443 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3444 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003445 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3446 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3447 "of pAttachment[%d].",
3448 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003449 }
3450 }
3451 }
3452 return skip;
3453}
3454
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003455bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3456 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003457 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003458 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003459 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003460 if (!cb_node) return skip;
3461
Petr Kraus2dffb382019-08-10 02:52:12 +02003462 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003463
3464 // Validate that attachment is in reference list of active subpass
3465 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003466 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003467 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003468 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003469 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003470 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003471
John Zulauf3a548ef2019-02-01 16:14:07 -07003472 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3473 auto clear_desc = &pAttachments[attachment_index];
3474 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003475 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003476
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003477 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3478 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3479 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3480 attachment_index);
3481 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3482 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3483 skip |=
3484 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3485 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3486 attachment_index);
3487 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003488 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3489 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3490 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3491 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003492 skip |= LogError(
3493 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3494 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3495 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3496 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003497 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003498 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003499
John Zulauff2582972019-02-09 14:53:30 -07003500 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3501 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003502 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003503 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3504 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3505 " subpass %u. colorAttachmentCount=%u",
3506 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003507 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003508 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003509 }
John Zulauff2582972019-02-09 14:53:30 -07003510 fb_attachment = color_attachment;
3511
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003512 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3513 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3514 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3515 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3516 "of a color attachment.",
3517 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003518 }
3519 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003520 bool subpass_depth = false;
3521 bool subpass_stencil = false;
3522 if (subpass_desc->pDepthStencilAttachment &&
3523 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3524 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3525 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3526 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3527 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003528 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003529 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3530 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003531 skip |= LogError(
3532 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3533 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003534 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003535 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003536 }
3537 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003538 skip |= LogError(
3539 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3540 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003541 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003542 attachment_index);
3543 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003544 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003545 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003546 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003547 if (subpass_depth) {
3548 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3549 "vkCmdClearAttachments()");
3550 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003551 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003552 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003553 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3554 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003555 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003556
3557 // Once the framebuffer attachment is found, can get the image view state
3558 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3559 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3560 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003561 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003562 if (image_view_state != nullptr) {
3563 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3564 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3565 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3566 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3567 }
3568 }
John Zulauf441558b2019-08-12 11:47:39 -06003569 }
3570 }
3571 return skip;
3572}
3573
3574void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3575 const VkClearAttachment *pAttachments, uint32_t rectCount,
3576 const VkClearRect *pRects) {
3577 auto *cb_node = GetCBState(commandBuffer);
3578 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003579 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3580 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003581 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3582 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3583 const auto clear_desc = &pAttachments[attachment_index];
3584 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3585 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3586 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3587 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3588 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3589 subpass_desc->pDepthStencilAttachment) {
3590 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3591 }
3592 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003593 if (!clear_rect_copy) {
3594 // We need a copy of the clear rectangles that will persist until the last lambda executes
3595 // but we want to create it as lazily as possible
3596 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003597 }
John Zulauf441558b2019-08-12 11:47:39 -06003598 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3599 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003600 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003601 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003602 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003603 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3604 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003605 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003606 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003607 return skip;
3608 };
3609 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003610 }
3611 }
3612 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003613}
3614
Jeff Leger178b1e52020-10-05 12:22:23 -04003615template <typename RegionType>
3616bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3617 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3618 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003619 const auto *cb_node = GetCBState(commandBuffer);
3620 const auto *src_image_state = GetImageState(srcImage);
3621 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3623 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3624 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3625 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003626
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003627 bool skip = false;
3628 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003629 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3630 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3631 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3632 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003633 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3635 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3636 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3637 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3638 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3639 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3640 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3641 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003642
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003643 // Validation for VK_EXT_fragment_density_map
3644 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003645 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003646 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003647 "%s: srcImage must not have been created with flags containing "
3648 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3649 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003650 }
3651 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003652 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003653 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003654 "%s: dstImage must not have been created with flags containing "
3655 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3656 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003657 }
3658
Cort Stratton7df30962018-05-17 19:45:57 -07003659 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003660 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003661 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3662 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003663 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003664 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3665 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3666 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003667 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003668 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3669 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3670 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3671 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3672 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3673 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003674 // For each region, the number of layers in the image subresource should not be zero
3675 // For each region, src and dest image aspect must be color only
3676 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003677 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003678 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3679 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003680 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3681 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3682 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003683 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3685 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003686 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003687 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3688 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3689 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3690 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3691 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3692 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003693 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003694 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3695 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003696 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003697 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003698
3699 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003700 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003701 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3702 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003703 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003704 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003705 }
Cort Stratton7df30962018-05-17 19:45:57 -07003706 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003707 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3708 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003709 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003710 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003711 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3712 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003713 }
3714
3715 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3716 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3717
3718 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003719 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003720 LogObjectList objlist(cb_node->commandBuffer());
3721 objlist.add(src_image_state->image());
3722 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003723 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3724 skip |= LogError(objlist, vuid,
3725 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003726 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003727 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003728 }
3729 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003730 LogObjectList objlist(cb_node->commandBuffer());
3731 objlist.add(src_image_state->image());
3732 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003733 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3734 skip |= LogError(objlist, vuid,
3735 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003736 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003737 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003738 }
3739 }
3740
3741 if (VK_IMAGE_TYPE_1D == src_image_type) {
3742 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003743 LogObjectList objlist(cb_node->commandBuffer());
3744 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003745 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3746 skip |= LogError(objlist, vuid,
3747 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003748 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003749 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003750 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003751 }
3752 }
3753 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3754 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003755 LogObjectList objlist(cb_node->commandBuffer());
3756 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003757 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3758 skip |= LogError(objlist, vuid,
3759 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003760 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003761 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003762 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003763 }
3764 }
3765
3766 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3767 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003768 LogObjectList objlist(cb_node->commandBuffer());
3769 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003770 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3771 skip |= LogError(objlist, vuid,
3772 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003773 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003774 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003775 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003776 }
3777 }
3778 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3779 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003780 LogObjectList objlist(cb_node->commandBuffer());
3781 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003782 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3783 skip |= LogError(objlist, vuid,
3784 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003785 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003786 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003787 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003788 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003789 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003790
3791 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003792 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003793 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3794 // developer
3795 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3796 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003797 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003798 LogObjectList objlist(cb_node->commandBuffer());
3799 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003800 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3801 skip |= LogError(objlist, vuid,
3802 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003803 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003804 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003805 region.extent.width, subresource_extent.width);
3806 }
3807
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003808 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003809 LogObjectList objlist(cb_node->commandBuffer());
3810 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003811 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3812 skip |= LogError(objlist, vuid,
3813 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003814 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003815 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003816 region.extent.height, subresource_extent.height);
3817 }
3818
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003819 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003820 LogObjectList objlist(cb_node->commandBuffer());
3821 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003822 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3823 skip |= LogError(objlist, vuid,
3824 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003825 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003826 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003827 region.extent.depth, subresource_extent.depth);
3828 }
3829 }
3830
3831 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003832 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003833 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3834 // developer
3835 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3836 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003837 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003838 LogObjectList objlist(cb_node->commandBuffer());
3839 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003840 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3841 skip |= LogError(objlist, vuid,
3842 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003843 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003844 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003845 region.extent.width, subresource_extent.width);
3846 }
3847
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003848 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003849 LogObjectList objlist(cb_node->commandBuffer());
3850 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003851 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3852 skip |= LogError(objlist, vuid,
3853 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003854 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003855 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003856 region.extent.height, subresource_extent.height);
3857 }
3858
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003859 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003860 LogObjectList objlist(cb_node->commandBuffer());
3861 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003862 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3863 skip |= LogError(objlist, vuid,
3864 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003865 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003866 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003867 region.extent.depth, subresource_extent.depth);
3868 }
3869 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003870 }
3871
3872 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003873 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003874 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 -04003875 func_name, string_VkFormat(src_image_state->createInfo.format),
3876 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003877 }
3878 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003879 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003880 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003881 string_VkImageType(src_image_state->createInfo.imageType),
3882 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003883 }
3884 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003885 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003886 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 -07003887 }
3888 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003889 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003890 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 -04003891 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003892 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003893 } else {
3894 assert(0);
3895 }
3896 return skip;
3897}
3898
Jeff Leger178b1e52020-10-05 12:22:23 -04003899bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3900 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3901 const VkImageResolve *pRegions) const {
3902 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3903 COPY_COMMAND_VERSION_1);
3904}
3905
3906bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3907 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3908 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3909 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3910 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3911}
3912
3913template <typename RegionType>
3914bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3915 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3916 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003917 const auto *cb_node = GetCBState(commandBuffer);
3918 const auto *src_image_state = GetImageState(srcImage);
3919 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003920
Jeff Leger178b1e52020-10-05 12:22:23 -04003921 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3922 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3923 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3924
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003925 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003926 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003927 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003928 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003929 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003930 const char *vuid;
3931 const char *location;
3932 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3933 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3934 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3935 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3936 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3937 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3938 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3939 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3940 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3941 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3942 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3943 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3944 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3945 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3946 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3947 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003949 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3950 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3951 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3952 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3953 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3954 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3955 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3956 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3957 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3958 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003959
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003960 // Validation for VK_EXT_fragment_density_map
3961 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003962 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003963 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003964 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3965 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003966 }
3967 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003968 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003969 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003970 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3971 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003972 }
3973
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003974 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003975
Dave Houlton33c2d252017-06-09 17:08:32 -06003976 VkFormat src_format = src_image_state->createInfo.format;
3977 VkFormat dst_format = dst_image_state->createInfo.format;
3978 VkImageType src_type = src_image_state->createInfo.imageType;
3979 VkImageType dst_type = dst_image_state->createInfo.imageType;
3980
Cort Stratton186b1a22018-05-01 20:18:06 -04003981 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3983 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3984 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003985 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003986 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003987 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003988 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003989 }
3990
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003991 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003992 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3993 skip |= LogError(device, vuid,
3994 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003995 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003996 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003997 }
3998
3999 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004000 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
4001 skip |= LogError(device, vuid,
4002 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004003 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004004 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004005 }
4006
Dave Houlton33c2d252017-06-09 17:08:32 -06004007 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004008 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004009 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004010 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004011 }
4012
Dave Houlton33c2d252017-06-09 17:08:32 -06004013 // Validate consistency for unsigned formats
4014 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
4015 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004016 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004017 << "the other one must also have unsigned integer format. "
4018 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004020 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004021 }
4022
4023 // Validate consistency for signed formats
4024 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
4025 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004026 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004027 << "the other one must also have signed integer format. "
4028 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004029 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004030 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004031 }
4032
4033 // Validate filter for Depth/Stencil formats
4034 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4035 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004037 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04004038 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004039 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004040 }
4041
4042 // Validate aspect bits and formats for depth/stencil images
4043 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4044 if (src_format != dst_format) {
4045 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004046 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 -06004047 << "stencil, the other one must have exactly the same format. "
4048 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4049 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004050 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004051 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004052 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004053 } // Depth or Stencil
4054
4055 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004056 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004057 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4058 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4059 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4060 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4061 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4062 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004063 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004064 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4065 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4066 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4067 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4068 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4069 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004070 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004071 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004072 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004073 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004074 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004075 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4076 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004077 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004078 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4079 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4080 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4081 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4082 skip |=
4083 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4084 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4085 skip |=
4086 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4087 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004088 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004089 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4090 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004091 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004092 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004093 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004094 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4095 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004096 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004097 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004098 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004099 }
Dave Houlton48989f32017-05-26 15:01:46 -06004100 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4101 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004102 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004103 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004104 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004105 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004106
4107 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004108 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004109 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4110 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004111 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004112 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004113 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004114
Dave Houlton48989f32017-05-26 15:01:46 -06004115 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004116 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4117 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004118 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004119 }
Dave Houlton48989f32017-05-26 15:01:46 -06004120
Dave Houlton33c2d252017-06-09 17:08:32 -06004121 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004122 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004123 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004124 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004125 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004126 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004127 }
4128
4129 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004130 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004131 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004132 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4133 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004134 }
4135
Dave Houlton48989f32017-05-26 15:01:46 -06004136 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004137 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004138 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004139 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004140 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004141 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004142 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4143 "of (%1d, %1d). These must be (0, 1).",
4144 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004145 }
4146 }
4147
Dave Houlton33c2d252017-06-09 17:08:32 -06004148 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004149 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004150 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004151 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004152 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4153 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4154 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004155 }
4156 }
4157
Dave Houlton33c2d252017-06-09 17:08:32 -06004158 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004159 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4160 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004161 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004162 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004163 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004164 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4165 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004166 }
4167 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4168 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004169 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004170 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004171 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004172 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4173 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004174 }
4175 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4176 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004177 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004178 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004179 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004180 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4181 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004182 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004183 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004184 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004185 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004186 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004187 }
Dave Houlton48989f32017-05-26 15:01:46 -06004188
4189 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004190 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004191 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004192 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004193 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004194 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004195 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4196 "(%1d, %1d). These must be (0, 1).",
4197 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004198 }
4199 }
4200
Dave Houlton33c2d252017-06-09 17:08:32 -06004201 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004202 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004203 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004204 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004205 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004206 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004207 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004208 }
4209 }
4210
Dave Houlton33c2d252017-06-09 17:08:32 -06004211 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004212 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4213 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004214 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004215 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004216 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004217 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4218 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004219 }
4220 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4221 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004222 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004223 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004224 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004225 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4226 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004227 }
4228 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4229 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004230 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004231 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004232 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004233 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4234 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004235 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004236 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004237 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004238 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004239 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004240 }
4241
Dave Houlton33c2d252017-06-09 17:08:32 -06004242 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4243 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4244 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004245 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004246 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004247 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4248 "layerCount other than 1.",
4249 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004250 }
4251 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004252 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004253 } else {
4254 assert(0);
4255 }
4256 return skip;
4257}
4258
Jeff Leger178b1e52020-10-05 12:22:23 -04004259bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4260 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4261 const VkImageBlit *pRegions, VkFilter filter) const {
4262 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4263 COPY_COMMAND_VERSION_1);
4264}
4265
4266bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4267 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4268 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4269 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4270}
4271
4272template <typename RegionType>
4273void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4274 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4275 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004276 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004277 auto src_image_state = GetImageState(srcImage);
4278 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004279
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004280 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004281 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004282 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4283 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004284 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004285}
4286
Jeff Leger178b1e52020-10-05 12:22:23 -04004287void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4288 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4289 const VkImageBlit *pRegions, VkFilter filter) {
4290 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4291 pRegions, filter);
4292 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4293}
4294
4295void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4296 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4297 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4298 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4299 pBlitImageInfo->filter);
4300}
4301
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004302GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004303 // This approach allows for a single hash lookup or/create new
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004304 auto &layout_map = map[image_state.image()];
John Zulauf17708d02021-02-22 11:20:58 -07004305 if (!layout_map) {
4306 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004307 }
John Zulauf17708d02021-02-22 11:20:58 -07004308 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004309}
4310
4311const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4312 auto it = map.find(image);
4313 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004314 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004315 }
4316 return nullptr;
4317}
4318
Jeremy Gebben53631302021-04-13 16:46:37 -06004319// Helper to update the Global or Overlay layout map
4320struct GlobalLayoutUpdater {
4321 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4322 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4323 dst = src.current_layout;
4324 return true;
4325 }
4326 return false;
4327 }
4328
4329 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4330 layer_data::optional<VkImageLayout> result;
4331 if (src.current_layout != image_layout_map::kInvalidLayout) {
4332 result.emplace(src.current_layout);
4333 }
4334 return result;
4335 }
4336};
4337
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004338// 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 -07004339bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004340 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004341 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004342 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004343 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004344 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004345 for (const auto &layout_map_entry : pCB->image_layout_map) {
4346 const auto image = layout_map_entry.first;
4347 const auto *image_state = GetImageState(image);
4348 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004349 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004350 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004351 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004352 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004353
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004354 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004355 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4356 if (global_map == nullptr) {
4357 global_map = &empty_map;
4358 }
4359
4360 // Note: don't know if it would matter
4361 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4362
Jeremy Gebben53631302021-04-13 16:46:37 -06004363 auto pos = layout_map.begin();
4364 const auto end = layout_map.end();
4365 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4366 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004367 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004368 VkImageLayout initial_layout = pos->second.initial_layout;
4369 assert(initial_layout != image_layout_map::kInvalidLayout);
4370 if (initial_layout == image_layout_map::kInvalidLayout) {
4371 continue;
4372 }
4373
John Zulauf2076e812020-01-08 14:55:54 -07004374 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004375
John Zulauf2076e812020-01-08 14:55:54 -07004376 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 -07004377 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004378 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004379 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004380 image_layout = current_layout->pos_B->lower_bound->second;
4381 }
4382 const auto intersected_range = pos->first & current_layout->range;
4383 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4384 // TODO: Set memory invalid which is in mem_tracker currently
4385 } else if (image_layout != initial_layout) {
4386 // Need to look up the inital layout *state* to get a bit more information
4387 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4388 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4389 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4390 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004391 // We can report all the errors for the intersected range directly
4392 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004393 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004394 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004395 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004396 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004397 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004398 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004399 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004400 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004401 }
4402 }
John Zulauf2076e812020-01-08 14:55:54 -07004403 if (pos->first.includes(intersected_range.end)) {
4404 current_layout.seek(intersected_range.end);
4405 } else {
4406 ++pos;
4407 if (pos != end) {
4408 current_layout.seek(pos->first.begin);
4409 }
4410 }
John Zulauff660ad62019-03-23 07:16:05 -06004411 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004412 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004413 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004414 }
John Zulauff660ad62019-03-23 07:16:05 -06004415
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004416 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004417}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004418
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004419void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004420 for (const auto &layout_map_entry : pCB->image_layout_map) {
4421 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004422 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004423 const auto *image_state = GetImageState(image);
4424 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004425 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004426 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004427 }
4428}
4429
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004430// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004431// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4432// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004433bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4434 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004435 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004436 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004437 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4438
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004439 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004440 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4441 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004442 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004443 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4444 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4445 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004446 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004447 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004448 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004449 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4450 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4451 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004452 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004453 string_VkImageLayout(first_layout));
4454 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4455 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004456 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004457 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004458 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004459 }
4460 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004461
4462 // Same as above for loadOp, but for stencilLoadOp
4463 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4464 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4465 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4466 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4467 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004468 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004469 string_VkImageLayout(first_layout));
4470 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4471 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4472 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004473 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004474 string_VkImageLayout(first_layout));
4475 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4476 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4477 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004478 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004479 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004480 }
4481 }
4482
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004483 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004484}
4485
Mark Lobodzinski96210742017-02-09 10:33:46 -07004486// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4487// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004488template <typename T1>
4489bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4490 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4491 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004492 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004493 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004494 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004495 if (strict) {
4496 correct_usage = ((actual & desired) == desired);
4497 } else {
4498 correct_usage = ((actual & desired) != 0);
4499 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004500
Mark Lobodzinski96210742017-02-09 10:33:46 -07004501 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004502 // All callers should have a valid VUID
4503 assert(msgCode != kVUIDUndefined);
4504 skip =
4505 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4506 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004507 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004508 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004509}
4510
4511// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4512// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004513bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004514 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004515 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004516 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004517}
4518
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004519bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004520 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004521 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004522 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4523 if ((image_format_features & desired) != desired) {
4524 // Same error, but more details if it was an AHB external format
4525 if (image_state->has_ahb_format == true) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004526 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004527 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4528 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4529 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004530 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004531 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004532 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004533 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4534 "with tiling %s.",
4535 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004536 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004537 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004538 }
4539 }
4540 return skip;
4541}
4542
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004543bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004544 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004545 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004546 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004547 // layerCount must not be zero
4548 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004549 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004550 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004551 }
4552 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004553 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004554 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004555 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004556 }
4557 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004558 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 -06004559 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004560 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4561 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4562 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004563 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004564 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4565 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4566 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004567 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004568 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4569 member);
4570 }
Cort Strattond619a302018-05-17 19:46:32 -07004571 return skip;
4572}
4573
Mark Lobodzinski96210742017-02-09 10:33:46 -07004574// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4575// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004576bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004577 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004578 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004579 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004580}
4581
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004582bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004583 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004584 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004585
4586 const VkDeviceSize &range = pCreateInfo->range;
4587 if (range != VK_WHOLE_SIZE) {
4588 // Range must be greater than 0
4589 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004590 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004591 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004592 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4593 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004594 }
4595 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004596 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4597 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004598 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004599 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004600 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4601 "(%" PRIu32 ").",
4602 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004603 }
4604 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004605 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004606 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004607 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004608 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4609 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4610 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004611 }
4612 // The sum of range and offset must be less than or equal to the size of buffer
4613 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004614 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004615 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004616 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4617 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4618 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004619 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004620 } else {
4621 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4622
4623 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4624 // VkPhysicalDeviceLimits::maxTexelBufferElements
4625 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4626 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004627 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004628 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4629 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4630 "), divided by the element size of the format (%" PRIu32
4631 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4632 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4633 device_limits->maxTexelBufferElements);
4634 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004635 }
4636 return skip;
4637}
4638
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004639bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004640 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004641 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004642 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4643 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004644 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004645 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004646 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4647 "be supported for uniform texel buffers",
4648 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004649 }
4650 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4651 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004652 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004653 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004654 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4655 "be supported for storage texel buffers",
4656 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004657 }
4658 return skip;
4659}
4660
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004661bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004662 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004663 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004664
Dave Houltond8ed0212018-05-16 17:18:24 -06004665 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004666
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004667 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004668 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004669 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004670 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004671 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4672 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004673 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004674 }
4675 }
4676
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004677 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004678 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004679 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004680 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004681 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004682 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4683 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004684 }
4685 }
4686
Mike Schuchardt2df08912020-12-15 16:28:09 -08004687 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004688 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4689 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004690 skip |= LogError(
4691 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004692 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004693 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004694 }
4695
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004696 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004697 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4698 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4699 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004700 }
4701
sfricke-samsungedce77a2020-07-03 22:35:13 -07004702 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4703 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4704 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4705 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4706 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4707 }
4708 const VkBufferCreateFlags invalid_flags =
4709 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4710 if ((pCreateInfo->flags & invalid_flags) != 0) {
4711 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4712 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4713 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4714 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4715 }
4716 }
4717
Mark Lobodzinski96210742017-02-09 10:33:46 -07004718 return skip;
4719}
4720
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004721bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004722 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004723 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004724 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004725 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4726 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004727 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004728 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4729 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004730 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004731 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4732 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4733 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004734
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004735 // Buffer view offset must be less than the size of buffer
4736 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004737 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004738 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004739 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4740 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004741 }
4742
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004743 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004744 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4745 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4746 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004747 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4748 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004749 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004750 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004751 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4752 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004753 }
4754
4755 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004756 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4757 if ((element_size % 3) == 0) {
4758 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004759 }
4760 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004761 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004762 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4763 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004764 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004765 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004766 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004768 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004769 "vkCreateBufferView(): If buffer was created with usage containing "
4770 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004771 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4772 ") must be a multiple of the lesser of "
4773 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4774 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4775 "(%" PRId32
4776 ") is VK_TRUE, the size of a texel of the requested format. "
4777 "If the size of a texel is a multiple of three bytes, then the size of a "
4778 "single component of format is used instead",
4779 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4780 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4781 }
4782 }
4783 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004784 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004785 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4786 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004787 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004788 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004789 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004790 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004791 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004792 "vkCreateBufferView(): If buffer was created with usage containing "
4793 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004794 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4795 ") must be a multiple of the lesser of "
4796 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4797 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4798 "(%" PRId32
4799 ") is VK_TRUE, the size of a texel of the requested format. "
4800 "If the size of a texel is a multiple of three bytes, then the size of a "
4801 "single component of format is used instead",
4802 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4803 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4804 }
4805 }
4806 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004807
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004808 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004809
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004810 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004811 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004812 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004813}
4814
Mark Lobodzinski602de982017-02-09 11:01:33 -07004815// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004816bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004817 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004818 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004819 const IMAGE_STATE *image_state = GetImageState(image);
4820 // checks color format and (single-plane or non-disjoint)
4821 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004822 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004823 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004824 skip |= LogError(
4825 image, vuid,
4826 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4827 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004828 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004829 skip |= LogError(image, vuid,
4830 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4831 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4832 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004833 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004834 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004835 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004836 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004837 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4838 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4839 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004840 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004841 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004842 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4843 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4844 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004845 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004846 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004847 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004848 skip |= LogError(image, vuid,
4849 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4850 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4851 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004852 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004853 skip |= LogError(image, vuid,
4854 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4855 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4856 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004857 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004858 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004859 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004860 skip |= LogError(image, vuid,
4861 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4862 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4863 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004864 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004865 skip |= LogError(image, vuid,
4866 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4867 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4868 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004869 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004870 } else if (FormatIsMultiplane(format)) {
4871 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4872 if (3 == FormatPlaneCount(format)) {
4873 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4874 }
4875 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004876 skip |= LogError(image, vuid,
4877 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4878 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4879 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004880 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004881 }
4882 return skip;
4883}
4884
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004885bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4886 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004887 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004888 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004889 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004890
4891 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004892 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004893 skip |= LogError(image, errorCodes.base_mip_err,
4894 "%s: %s.baseMipLevel (= %" PRIu32
4895 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4896 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004897 }
Petr Kraus4d718682017-05-18 03:38:41 +02004898
Petr Krausffa94af2017-08-08 21:46:02 +02004899 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4900 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004901 skip |=
4902 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004903 } else {
4904 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004905
Petr Krausffa94af2017-08-08 21:46:02 +02004906 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004907 skip |= LogError(image, errorCodes.mip_count_err,
4908 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4909 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4910 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4911 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004912 }
Petr Kraus4d718682017-05-18 03:38:41 +02004913 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004914 }
Petr Kraus4d718682017-05-18 03:38:41 +02004915
4916 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004917 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004918 skip |= LogError(image, errorCodes.base_layer_err,
4919 "%s: %s.baseArrayLayer (= %" PRIu32
4920 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4921 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004922 }
Petr Kraus4d718682017-05-18 03:38:41 +02004923
Petr Krausffa94af2017-08-08 21:46:02 +02004924 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4925 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004926 skip |=
4927 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004928 } else {
4929 const uint64_t necessary_layer_count =
4930 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004931
Petr Krausffa94af2017-08-08 21:46:02 +02004932 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004933 skip |= LogError(image, errorCodes.layer_count_err,
4934 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4935 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4936 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4937 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004938 }
Petr Kraus4d718682017-05-18 03:38:41 +02004939 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004940 }
Petr Kraus4d718682017-05-18 03:38:41 +02004941
Mark Lobodzinski602de982017-02-09 11:01:33 -07004942 return skip;
4943}
4944
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004945bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004946 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004947 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004948 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004949 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004950 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 +02004951
David McFarland2853f2f2020-11-30 15:50:39 -04004952 uint32_t image_layer_count;
4953
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004954 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004955 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004956 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004957 image_layer_count = extent.depth;
4958 } else {
4959 image_layer_count = image_state->createInfo.arrayLayers;
4960 }
4961
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004962 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004963
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004964 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4965 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4966 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4967 subresource_range_error_codes.base_layer_err =
4968 is_khr_maintenance1
4969 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4970 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4971 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4972 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4973 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4974 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004975
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004976 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004977 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004978 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004979}
4980
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004981bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004982 const VkImageSubresourceRange &subresourceRange,
4983 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004984 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4985 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4986 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4987 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4988 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004989
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004990 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004991 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004992 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004993}
4994
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004995bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004996 const VkImageSubresourceRange &subresourceRange,
4997 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004998 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4999 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5000 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5001 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5002 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005003
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005004 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005005 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005006 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005007}
5008
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005009bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005010 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005011 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005012 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005013 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005014}
5015
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005016namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005017using sync_vuid_maps::GetBarrierQueueVUID;
5018using sync_vuid_maps::kQueueErrorSummary;
5019using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005020
5021class ValidatorState {
5022 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005023 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005024 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5025 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005026 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005027 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005028 barrier_handle_(barrier_handle),
5029 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005030 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5031 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5032
5033 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5034 // 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 -07005035 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5036 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005037 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005038 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5039 loc_.Message().c_str(), GetTypeString(),
5040 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5041 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005042 }
5043
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005044 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5045 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005046 const char *src_annotation = GetFamilyAnnotation(src_family);
5047 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5048 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005049 objects_, val_code,
5050 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5051 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5052 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005053 }
5054
5055 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5056 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5057 // application input.
5058 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5059 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005060 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005061 uint32_t queue_family = queue_state->queueFamilyIndex;
5062 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005063 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005064 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5065 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5066 return device_data->LogError(
5067 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005068 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005069 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005070 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005071 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005072 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005073 }
5074 return false;
5075 }
5076 // Logical helpers for semantic clarity
5077 inline bool KhrExternalMem() const { return mem_ext_; }
5078 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5079 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5080 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5081 }
5082
5083 // Helpers for LogMsg
5084 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5085
5086 // Descriptive text for the various types of queue family index
5087 const char *GetFamilyAnnotation(uint32_t family) const {
5088 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5089 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5090 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5091 const char *valid = " (VALID)";
5092 const char *invalid = " (INVALID)";
5093 switch (family) {
5094 case VK_QUEUE_FAMILY_EXTERNAL:
5095 return external;
5096 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5097 return foreign;
5098 case VK_QUEUE_FAMILY_IGNORED:
5099 return ignored;
5100 default:
5101 if (IsValid(family)) {
5102 return valid;
5103 }
5104 return invalid;
5105 };
5106 }
5107 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5108 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5109
5110 protected:
5111 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005112 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005113 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005114 const VulkanTypedHandle barrier_handle_;
5115 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005116 const uint32_t limit_;
5117 const bool mem_ext_;
5118};
5119
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005120bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005121 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5122 bool skip = false;
5123
5124 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5125 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5126 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5127 if (val.KhrExternalMem()) {
5128 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005129 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5130 // this requirement is removed by VK_KHR_synchronization2
5131 if (!(src_ignored || dst_ignored) && !sync2) {
5132 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005133 }
5134 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5135 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005136 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005137 }
5138 } else {
5139 // VK_SHARING_MODE_EXCLUSIVE
5140 if (src_queue_family != dst_queue_family) {
5141 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005142 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005143 }
5144 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005145 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005146 }
5147 }
5148 }
5149 } else {
5150 // No memory extension
5151 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005152 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5153 // this requirement is removed by VK_KHR_synchronization2
5154 if ((!src_ignored || !dst_ignored) && !sync2) {
5155 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005156 }
5157 } else {
5158 // VK_SHARING_MODE_EXCLUSIVE
5159 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005160 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005161 }
5162 }
5163 }
5164 return skip;
5165}
5166} // namespace barrier_queue_families
5167
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005168bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005169 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005170 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5171 uint32_t dst_queue_family) {
5172 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005173 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005174 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5175}
5176
5177// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005178template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005179bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5180 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005181 // State data is required
5182 if (!state_data) {
5183 return false;
5184 }
5185
5186 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005187 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005188 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005189 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5190 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005191 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005192}
5193
5194// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005195template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005196bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5197 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005198 // State data is required
5199 if (!state_data) {
5200 return false;
5201 }
5202
5203 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005204 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005205 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005206 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5207 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005208 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5209}
5210
5211template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005212bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005213 const Barrier &mem_barrier) const {
5214 using sync_vuid_maps::BufferError;
5215 using sync_vuid_maps::GetBufferBarrierVUID;
5216
5217 bool skip = false;
5218
5219 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5220
5221 // Validate buffer barrier queue family indices
5222 auto buffer_state = GetBufferState(mem_barrier.buffer);
5223 if (buffer_state) {
5224 auto buf_loc = loc.dot(Field::buffer);
5225 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005226 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005227
5228 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5229
5230 auto buffer_size = buffer_state->createInfo.size;
5231 if (mem_barrier.offset >= buffer_size) {
5232 auto offset_loc = loc.dot(Field::offset);
5233 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5234
5235 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5236 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5237 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5238 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5239 auto size_loc = loc.dot(Field::size);
5240 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5241 skip |= LogError(objects, vuid,
5242 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5243 ".",
5244 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5245 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5246 }
5247 if (mem_barrier.size == 0) {
5248 auto size_loc = loc.dot(Field::size);
5249 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5250 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5251 report_data->FormatHandle(mem_barrier.buffer).c_str());
5252 }
5253 }
5254 return skip;
5255}
5256
5257template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005258bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005259 const Barrier &mem_barrier) const {
5260 bool skip = false;
5261
5262 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5263
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005264 bool is_ilt = true;
5265 if (enabled_features.synchronization2_features.synchronization2) {
5266 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5267 }
5268
5269 if (is_ilt) {
5270 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5271 auto layout_loc = loc.dot(Field::newLayout);
5272 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5273 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005274 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005275 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005276 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005277 }
5278
5279 auto image_data = GetImageState(mem_barrier.image);
5280 if (image_data) {
5281 auto image_loc = loc.dot(Field::image);
5282
John Zulaufbea70432021-02-23 07:03:12 -07005283 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005284
5285 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5286
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005287 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005288 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005289
5290 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5291 }
5292 return skip;
5293}
5294
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005295bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5296 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5297 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005298 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5299 const VkImageMemoryBarrier *pImageMemBarriers) const {
5300 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06005301 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005302 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005303 auto op_type =
5304 ComputeBarrierOperationsType(cb_state, bufferBarrierCount, pBufferMemBarriers, imageMemBarrierCount, pImageMemBarriers);
5305
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005306 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5307 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005308 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005309 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
5310 }
5311 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5312 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005313 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005314 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005315 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5316 }
5317 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005318 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005319 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5320 }
5321 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5322 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005323 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005324 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005325 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5326 }
5327 return skip;
5328}
5329
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005330bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
5331 BarrierOperationsType op_type, const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005332 bool skip = false;
5333
5334 if (cb_state->activeRenderPass) {
5335 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5336 if (skip) return true; // Early return to avoid redundant errors from below calls
5337 }
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06005338 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005339 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5340 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005341 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005342 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5343 }
5344 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5345 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005346 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005347 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5348 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5349 }
5350 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005351 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005352 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5353 }
5354
5355 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5356 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005357 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005358 skip |= ValidateMemoryBarrier(objects, loc, op_type, queue_flags, mem_barrier);
5359 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5360 }
5361
5362 return skip;
5363}
5364
5365template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005366bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, BarrierOperationsType op_type,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005367 VkQueueFlags queue_flags, const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
5368 VkPipelineStageFlags dst_stage_mask) const {
5369 bool skip = false;
5370 if (op_type == kAllRelease || op_type == kGeneral) {
5371 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5372 }
5373 if (op_type == kAllAcquire || op_type == kGeneral) {
5374 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5375 }
5376 return skip;
5377}
5378
5379template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005380bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, BarrierOperationsType op_type,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005381 VkQueueFlags queue_flags, const Barrier &barrier) const {
5382 bool skip = false;
5383 if (op_type == kAllRelease || op_type == kGeneral) {
5384 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
5385 skip |=
5386 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5387 }
5388 if (op_type == kAllAcquire || op_type == kGeneral) {
5389 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
5390 skip |=
5391 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5392 }
5393 return skip;
5394}
5395
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005396bool CoreChecks::ValidateSubpassBarrier(const LogObjectList &objects, const Location &loc, VkQueueFlags queue_flags,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005397 const VkSubpassDependency2 &barrier) const {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005398 bool skip = false;
5399 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(barrier.pNext);
5400 if (mem_barrier) {
5401 if (enabled_features.synchronization2_features.synchronization2) {
5402 if (barrier.srcAccessMask != 0) {
5403 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5404 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5405 loc.dot(Field::srcAccessMask).Message().c_str());
5406 }
5407 if (barrier.dstAccessMask != 0) {
5408 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5409 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5410 loc.dot(Field::dstAccessMask).Message().c_str());
5411 }
5412 if (barrier.srcStageMask != 0 || barrier.dstStageMask != 0) {
5413 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5414 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5415 loc.dot(Field::srcStageMask).Message().c_str());
5416 }
5417 if (barrier.dstStageMask != 0) {
5418 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5419 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5420 loc.dot(Field::dstStageMask).Message().c_str());
5421 }
5422
5423 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc.dot(Field::pNext), kGeneral, queue_flags, *mem_barrier);
5424 return skip;
5425 } else {
5426 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5427 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5428 loc.Message().c_str());
5429 }
5430 }
5431 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc, kGeneral, queue_flags, barrier);
5432 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005433}
5434
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005435bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5436 const VkImageUsageFlags image_usage) const {
5437 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5438 bool skip = false;
5439
5440 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5441 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5442
5443 if (image_state->has_ahb_format == true) {
5444 // AHB image view and image share same feature sets
5445 tiling_features = image_state->format_features;
5446 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5447 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5448 assert(device_extensions.vk_ext_image_drm_format_modifier);
5449 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5450 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005451 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005452
5453 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5454 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5455 nullptr};
5456 format_properties_2.pNext = (void *)&drm_properties_list;
5457 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5458
nyorain38a9d232021-03-06 13:06:12 +01005459 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5460 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5461 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5462
5463 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5464
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005465 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5466 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5467 0) {
5468 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5469 }
5470 }
5471 } else {
5472 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5473 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5474 : format_properties.optimalTilingFeatures;
5475 }
5476
5477 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005478 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005479 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5480 "physical device.",
5481 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5482 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005483 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005484 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5485 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5486 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5487 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005488 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005489 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5490 "VK_IMAGE_USAGE_STORAGE_BIT.",
5491 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5492 } 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 -06005493 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005494 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5495 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5496 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5497 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5498 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005499 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005500 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5501 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5502 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5503 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5504 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005505 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005506 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5507 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5508 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005509 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5510 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5511 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005512 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005513 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5514 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5515 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5516 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005517 }
5518
5519 return skip;
5520}
5521
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005522bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005523 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005524 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005525 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005526 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005527 skip |=
5528 ValidateImageUsageFlags(image_state,
5529 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5530 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005531 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5532 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5533 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005534 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005535 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005536 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005537 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005538 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005539 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005540 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005541 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005542
5543 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5544 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005545 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005546 VkFormat view_format = pCreateInfo->format;
5547 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005548 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005549 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005550
Dave Houltonbd2e2622018-04-10 16:41:14 -06005551 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005552 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005553 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005554 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005555 if (!device_extensions.vk_ext_separate_stencil_usage) {
5556 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005557 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5558 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5559 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005560 }
5561 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005562 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005563 if (image_stencil_struct == nullptr) {
5564 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005565 skip |= LogError(
5566 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005567 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5568 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5569 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5570 }
5571 } else {
5572 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5573 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5574 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005575 skip |= LogError(
5576 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005577 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5578 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5579 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5580 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5581 }
5582 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5583 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005584 skip |= LogError(
5585 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005586 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5587 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5588 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5589 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5590 }
5591 }
5592 }
5593 }
5594
Dave Houltonbd2e2622018-04-10 16:41:14 -06005595 image_usage = chained_ivuci_struct->usage;
5596 }
5597
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005598 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5599 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5600 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5601 bool foundFormat = false;
5602 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5603 if (format_list_info->pViewFormats[i] == view_format) {
5604 foundFormat = true;
5605 break;
5606 }
5607 }
5608 if (foundFormat == false) {
5609 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5610 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5611 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5612 string_VkFormat(view_format));
5613 }
5614 }
5615
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005616 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5617 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005618 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005619 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005620 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005621 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005622 std::stringstream ss;
5623 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005624 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005625 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005626 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005627 }
5628 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005629 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005630 // 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 -07005631 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5632 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5633 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5634 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005635 const char *error_vuid;
5636 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5637 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5638 } else if ((device_extensions.vk_khr_maintenance2) &&
5639 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5640 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5641 } else if ((!device_extensions.vk_khr_maintenance2) &&
5642 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5643 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5644 } else {
5645 // both enabled
5646 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5647 }
Dave Houltonc7988072018-04-16 11:46:56 -06005648 std::stringstream ss;
5649 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005650 << " is not in the same format compatibility class as "
5651 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005652 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5653 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005654 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005655 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005656 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005657 }
5658 } else {
5659 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005660 // Unless it is a multi-planar color bit aspect
5661 if ((image_format != view_format) &&
5662 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5663 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5664 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005665 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005666 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005667 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005668 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005669 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005670 }
5671 }
5672
5673 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005674 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005675
5676 switch (image_type) {
5677 case VK_IMAGE_TYPE_1D:
5678 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005679 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5680 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5681 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005682 }
5683 break;
5684 case VK_IMAGE_TYPE_2D:
5685 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5686 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5687 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005688 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5689 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5690 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005691 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005692 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5693 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5694 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005695 }
5696 }
5697 break;
5698 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005699 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005700 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5701 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005702 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005703 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005704 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5705 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5706 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005707 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5708 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005709 skip |= LogError(
5710 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5711 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5712 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5713 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5714 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005715 }
5716 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005717 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5718 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5719 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005720 }
5721 }
5722 } else {
5723 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005724 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5725 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5726 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005727 }
5728 }
5729 break;
5730 default:
5731 break;
5732 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005733
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005734 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005735 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005736 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005737 }
5738
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005739 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005740
Tobias Hector6663c9b2020-11-05 10:18:02 +00005741 if (enabled_features.shading_rate_image.shadingRateImage) {
5742 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5743 if (view_format != VK_FORMAT_R8_UINT) {
5744 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5745 "vkCreateImageView() If image was created with usage containing "
5746 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5747 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005748 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005749 }
5750
5751 if (enabled_features.shading_rate_image.shadingRateImage ||
5752 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5753 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5754 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5755 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5756 "vkCreateImageView() If image was created with usage containing "
5757 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5758 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5759 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005760 }
5761 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005762
Tobias Hector6663c9b2020-11-05 10:18:02 +00005763 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5764 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5765 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5766 pCreateInfo->subresourceRange.layerCount != 1) {
5767 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5768 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5769 pCreateInfo->subresourceRange.layerCount);
5770 }
5771
Jeff Bolz99e3f632020-03-24 22:59:22 -05005772 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5773 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5774 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5775 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5776 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5777 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5778 }
5779 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5780 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5781 skip |= LogError(
5782 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5783 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5784 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5785 }
5786 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005787
5788 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5789 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005790 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005791 "vkCreateImageView(): If image was created with usage containing "
5792 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5793 pCreateInfo->subresourceRange.levelCount);
5794 }
5795 }
5796 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5797 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005798 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005799 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5800 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5801 }
5802 } else {
5803 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5804 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5805 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005806 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005807 "vkCreateImageView(): If image was created with usage containing "
5808 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5809 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5810 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5811 }
5812 }
5813 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005814
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005815 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5816 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5817 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5818 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5819 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5820 }
5821 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5822 skip |=
5823 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5824 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5825 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5826 }
5827 }
5828 if (device_extensions.vk_ext_fragment_density_map_2) {
5829 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5830 (pCreateInfo->subresourceRange.layerCount >
5831 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5832 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5833 "vkCreateImageView(): If image was created with flags containing "
5834 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5835 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5836 pCreateInfo->subresourceRange.layerCount,
5837 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5838 }
5839 }
5840
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005841 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005842 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5843 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5844 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5845 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5846 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5847 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5848 }
5849 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005850
5851 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5852 // If swizzling is disabled, make sure it isn't used
5853 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5854 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5855 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5856 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5857 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5858 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5859 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5860 }
5861
5862 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5863 // disabled
5864 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5865 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5866 // spec. See Github issue #2361.
5867 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5868 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5869 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5870 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5871 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5872 "vkCreateImageView (portability error): ImageView format must have"
5873 " the same number of components and bits per component as the Image's format");
5874 }
5875 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005876 }
5877 return skip;
5878}
5879
Jeff Leger178b1e52020-10-05 12:22:23 -04005880template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005881bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005882 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005883 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005884 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5885 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5886 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005887
5888 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5889 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5890 VkDeviceSize src_min = UINT64_MAX;
5891 VkDeviceSize src_max = 0;
5892 VkDeviceSize dst_min = UINT64_MAX;
5893 VkDeviceSize dst_max = 0;
5894
5895 for (uint32_t i = 0; i < regionCount; i++) {
5896 src_min = std::min(src_min, pRegions[i].srcOffset);
5897 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5898 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5899 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5900
5901 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5902 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005903 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005904 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005905 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5906 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005907 }
5908
5909 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5910 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005911 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005912 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005913 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5914 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005915 }
5916
5917 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5918 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005919 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005920 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005921 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005922 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005923 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005924 }
5925
5926 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5927 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005928 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005929 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005930 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005931 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005932 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005933 }
5934 }
5935
5936 // 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 -06005937 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005938 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005939 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005940 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04005941 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005942 }
5943 }
5944
5945 return skip;
5946}
5947
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005948bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005949 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005950 const auto cb_node = GetCBState(commandBuffer);
5951 const auto src_buffer_state = GetBufferState(srcBuffer);
5952 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005953
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005954 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005955 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5956 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005957 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005958 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005959 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5960 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005961 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005962 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5963 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005964 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Jeff Leger178b1e52020-10-05 12:22:23 -04005965 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005966 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5967 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5968 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005969 return skip;
5970}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005971
Jeff Leger178b1e52020-10-05 12:22:23 -04005972bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5973 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5974 const auto cb_node = GetCBState(commandBuffer);
5975 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5976 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5977
5978 bool skip = false;
5979 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5980 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5981 // Validate that SRC & DST buffers have correct usage flags set
5982 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5983 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5984 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5985 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5986 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5987 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005988 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
Jeff Leger178b1e52020-10-05 12:22:23 -04005989 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5990 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5991 skip |=
5992 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5993 skip |=
5994 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5995 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5996 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5997 return skip;
5998}
5999
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006000bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006001 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006002 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006003 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006004 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006005 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6006 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006007 }
6008 }
6009 return skip;
6010}
6011
Jeff Bolz5c801d12019-10-09 10:38:45 -05006012bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6013 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006014 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006015
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006016 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006017 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006018 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006019 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006020 }
6021 return skip;
6022}
6023
Jeff Bolz5c801d12019-10-09 10:38:45 -05006024bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006025 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006026
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006027 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006028 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006029 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006030 }
6031 return skip;
6032}
6033
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006034bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006035 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006036 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006037 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006038 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006039 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006040 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006041 }
6042 return skip;
6043}
6044
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006045bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006046 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006047 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006048 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006049 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006050 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006051 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006052 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006053 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6054 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006055
sfricke-samsung022fa252020-07-24 03:26:16 -07006056 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6057 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6058
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006059 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006060 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6061 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6062 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6063 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006064 }
6065
6066 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006067 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6068 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6069 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6070 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006071 }
6072
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006073 return skip;
6074}
6075
Jeff Leger178b1e52020-10-05 12:22:23 -04006076template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006077bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006078 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006079 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006080 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006081 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6082 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006083
sfricke-samsung125d2b42020-05-28 06:32:43 -07006084 assert(image_state != nullptr);
6085 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006086
6087 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006088 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006089 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6090 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006091 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006092 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6093 "and 1, respectively.",
6094 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006095 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006096 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006097
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006098 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6099 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006100 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006101 "%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 -07006102 "must be 0 and 1, respectively.",
6103 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006104 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006105 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006106
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006107 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6108 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006109 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006110 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006111 "For 3D images these must be 0 and 1, respectively.",
6112 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006113 }
6114 }
6115
6116 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006117 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006118 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6119 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006120
sfricke-samsung8feecc12021-01-23 03:28:38 -08006121 if (FormatIsDepthOrStencil(image_format)) {
6122 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006123 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006124 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6125 " must be a multiple 4 if using a depth/stencil format (%s).",
6126 function, i, bufferOffset, string_VkFormat(image_format));
6127 }
6128 } else {
6129 // If not depth/stencil and not multi-plane
6130 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6131 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6132 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6133 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006134 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006135 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6136 " must be a multiple of this format's texel size (%" PRIu32 ").",
6137 function, i, bufferOffset, element_size);
6138 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006139 }
6140
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006141 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6142 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006143 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006144 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006145 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006146 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006147 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006148 }
6149
6150 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6151 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006152 vuid =
6153 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006154 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006155 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006156 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6157 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006158 }
6159
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006160 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006161 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006162 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006163 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 -06006164 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6165 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006166 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006167 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006168 "zero or <= image subresource width (%d).",
6169 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006170 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006171 }
6172
6173 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006174 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 -06006175 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6176 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006177 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006178 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006179 "zero or <= image subresource height (%d).",
6180 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006181 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006182 }
6183
6184 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006185 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 -06006186 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6187 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006188 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006189 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006190 "zero or <= image subresource depth (%d).",
6191 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006192 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006193 }
6194
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006195 // subresource aspectMask must have exactly 1 bit set
6196 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006197 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006198 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006199 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006200 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006201 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006202 }
6203
6204 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006205 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006206 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006207 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006208 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6209 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006210 }
6211
6212 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006213 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6214 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006215
6216 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006217 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006218 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006219 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006220 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04006221 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006222 }
6223
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006224 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006225 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006226 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006227 image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006228 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006229 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006230 }
6231
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006232 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006233 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6234 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6235 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006236 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006237 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006238 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006239 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6240 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006241 }
6242
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006243 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006244 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006245 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006246 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006247 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Petr Krausb0d5e592021-05-21 23:37:11 +02006248 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ").",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006249 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006250 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006251
6252 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006253 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006254 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006255 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006256 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006257 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006258 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006259 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6260 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006261 }
6262
6263 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006264 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006265 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006266 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006267 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006268 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006269 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6270 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006271 }
6272
6273 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006274 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006275 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006276 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006277 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006278 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006279 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6280 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006281 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006282 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006283
6284 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006285 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006286 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006287 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006288 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006289 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006290 "format has three planes.",
6291 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006292 }
6293
6294 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006295 if (0 ==
6296 (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 -06006297 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006298 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006299 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6300 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006301 } else {
6302 // Know aspect mask is valid
6303 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6304 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006305 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006306 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006307 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006308 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006309 " 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 -08006310 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006311 string_VkFormat(compatible_format));
6312 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006313 }
6314 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006315
6316 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6317 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6318 assert(command_pool != nullptr);
6319 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6320 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6321 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006322 LogObjectList objlist(cb_node->commandBuffer());
6323 objlist.add(command_pool->commandPool());
6324 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006325 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6326 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6327 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6328 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006329 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6330 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006331 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006332 }
6333
6334 return skip;
6335}
6336
Jeff Leger178b1e52020-10-05 12:22:23 -04006337template <typename BufferImageCopyRegionType>
6338bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6339 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006340 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006341 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006342
6343 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006344 VkExtent3D extent = pRegions[i].imageExtent;
6345 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006346
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006347 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6348 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006349 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006350 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6351 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006352 }
6353
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006354 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006355
6356 // 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 -06006357 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006358 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006359 if (image_extent.width % block_extent.width) {
6360 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6361 }
6362 if (image_extent.height % block_extent.height) {
6363 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6364 }
6365 if (image_extent.depth % block_extent.depth) {
6366 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6367 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006368 }
6369
Dave Houltonfc1a4052017-04-27 14:32:45 -06006370 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006371 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006372 }
6373 }
6374
6375 return skip;
6376}
6377
Jeff Leger178b1e52020-10-05 12:22:23 -04006378template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006379bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006380 const BufferImageCopyRegionType *pRegions, const char *func_name,
6381 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006382 bool skip = false;
6383
6384 VkDeviceSize buffer_size = buff_state->createInfo.size;
6385
6386 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006387 VkDeviceSize max_buffer_offset =
6388 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6389 if (buffer_size < max_buffer_offset) {
6390 skip |=
Petr Krausb0d5e592021-05-21 23:37:11 +02006391 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 -07006392 }
6393 }
6394
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006395 return skip;
6396}
6397
Jeff Leger178b1e52020-10-05 12:22:23 -04006398template <typename BufferImageCopyRegionType>
6399bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6400 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6401 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006402 const auto cb_node = GetCBState(commandBuffer);
6403 const auto src_image_state = GetImageState(srcImage);
6404 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006405
Jeff Leger178b1e52020-10-05 12:22:23 -04006406 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6407 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6408 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6409 const char *vuid;
6410
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006411 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006412
6413 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006414 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006415
6416 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006417 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006418
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006419 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006420
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006421 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006422 vuid =
6423 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6424 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6425 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6426 "or transfer capabilities.",
6427 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006428 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006429 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6430 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6431 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6432 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006433
Jeff Leger178b1e52020-10-05 12:22:23 -04006434 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6435 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6436 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6437
6438 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6439 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6440 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6441 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006442
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006443 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006444 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6445 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006446 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006447 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6448 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006449 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006450 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6451 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6452 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6453 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6454 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6455 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006456
6457 // Validation for VK_EXT_fragment_density_map
6458 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006459 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006460 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006461 "%s: srcImage must not have been created with flags containing "
6462 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6463 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006464 }
6465
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006466 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006467 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6468 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006469 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006470 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006471
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006472 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 -04006473 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6474 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6475 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6476 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6477
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006478 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006479 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6480 vuid =
6481 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006482 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006483 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6484 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6485 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6486 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6487 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6488 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6489 "imageSubresource", vuid);
6490 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6491 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006492 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006493 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006494 }
6495 return skip;
6496}
6497
Jeff Leger178b1e52020-10-05 12:22:23 -04006498bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6499 VkBuffer dstBuffer, uint32_t regionCount,
6500 const VkBufferImageCopy *pRegions) const {
6501 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6502 COPY_COMMAND_VERSION_1);
6503}
6504
6505bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6506 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6507 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6508 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6509 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6510}
6511
John Zulauf1686f232019-07-09 16:27:11 -06006512void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6513 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6514 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6515
6516 auto cb_node = GetCBState(commandBuffer);
6517 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006518 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006519 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006520 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006521 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006522}
6523
Jeff Leger178b1e52020-10-05 12:22:23 -04006524void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6525 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6526 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6527
6528 auto cb_node = GetCBState(commandBuffer);
6529 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6530 // Make sure that all image slices record referenced layout
6531 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6532 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6533 pCopyImageToBufferInfo->srcImageLayout);
6534 }
6535}
6536
6537template <typename RegionType>
6538bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6539 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6540 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006541 const auto cb_node = GetCBState(commandBuffer);
6542 const auto src_buffer_state = GetBufferState(srcBuffer);
6543 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006544
Jeff Leger178b1e52020-10-05 12:22:23 -04006545 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6546 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6547 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6548 const char *vuid;
6549
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006550 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006551
6552 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006553 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006554
Jeff Leger178b1e52020-10-05 12:22:23 -04006555 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6556 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6557 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6558 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6559
6560 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6561 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6562 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6563 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6564 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6565 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6566 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6567 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6568 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006569 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006570 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6571 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006572 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006573 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6574 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6575 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6576 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6577 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6578 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006579
6580 // Validation for VK_EXT_fragment_density_map
6581 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006582 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006583 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006584 "%s: dstImage must not have been created with flags containing "
6585 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6586 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006587 }
6588
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006589 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006590 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6591 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006592 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006593 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006594
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006595 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 -04006596 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6597 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6598 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6599 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6600
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006601 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006602 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6603 vuid =
6604 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006605 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006606 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6607 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6608 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6609 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6610 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6611 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6612 "imageSubresource", vuid);
6613 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6614 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006615 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006616 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006617
6618 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6619 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6620 assert(command_pool != nullptr);
6621 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6622 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6623 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6624 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6625 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006626 LogObjectList objlist(cb_node->commandBuffer());
6627 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006628 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6629 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006630 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006631 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6632 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6633 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006634 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6635 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006636 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006637 }
6638 return skip;
6639}
6640
Jeff Leger178b1e52020-10-05 12:22:23 -04006641bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6642 VkImageLayout dstImageLayout, uint32_t regionCount,
6643 const VkBufferImageCopy *pRegions) const {
6644 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6645 COPY_COMMAND_VERSION_1);
6646}
6647
6648bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6649 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6650 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6651 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6652 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6653}
6654
John Zulauf1686f232019-07-09 16:27:11 -06006655void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6656 VkImageLayout dstImageLayout, uint32_t regionCount,
6657 const VkBufferImageCopy *pRegions) {
6658 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6659
6660 auto cb_node = GetCBState(commandBuffer);
6661 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006662 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006663 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006664 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006665 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006666}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006667
Jeff Leger178b1e52020-10-05 12:22:23 -04006668void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6669 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6670 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6671
6672 auto cb_node = GetCBState(commandBuffer);
6673 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6674 // Make sure that all image slices are record referenced layout
6675 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6676 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6677 pCopyBufferToImageInfo2KHR->dstImageLayout);
6678 }
6679}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006680bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006681 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006682 bool skip = false;
6683 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6684
Dave Houlton1d960ff2018-01-19 12:17:05 -07006685 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006686 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6687 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6688 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006689 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6690 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006691 }
6692
John Zulaufa26d3c82019-08-14 16:09:08 -06006693 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006694 if (!image_entry) {
6695 return skip;
6696 }
6697
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006698 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6699 if (device_extensions.vk_ext_image_drm_format_modifier) {
6700 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6701 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006702 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6703 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6704 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006705 }
6706 } else {
6707 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006708 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6709 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006710 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006711 }
6712
Dave Houlton1d960ff2018-01-19 12:17:05 -07006713 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006714 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006715 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6716 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6717 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006718 }
6719
Dave Houlton1d960ff2018-01-19 12:17:05 -07006720 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006721 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006722 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6723 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6724 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006725 }
6726
Dave Houlton1d960ff2018-01-19 12:17:05 -07006727 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006728 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006729 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6730 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006731 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006732 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6733 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006734 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006735 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6736 }
6737 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006738 skip |= LogError(image, vuid,
6739 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6740 ") must be a single-plane specifier flag.",
6741 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006742 }
6743 } else if (FormatIsColor(img_format)) {
6744 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006745 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6746 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6747 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006748 }
6749 } else if (FormatIsDepthOrStencil(img_format)) {
6750 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6751 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006752 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006753 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6754 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6755 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6756 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006757 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6758 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6759 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006760 }
6761 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006762
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006763 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006764 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006765 }
6766
Mike Weiblen672b58b2017-02-21 14:32:53 -07006767 return skip;
6768}
sfricke-samsung022fa252020-07-24 03:26:16 -07006769
6770// Validates the image is allowed to be protected
6771bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006772 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006773 bool skip = false;
6774 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006775 LogObjectList objlist(cb_state->commandBuffer());
6776 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006777 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 -06006778 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6779 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006780 }
6781 return skip;
6782}
6783
6784// Validates the image is allowed to be unprotected
6785bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006786 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006787 bool skip = false;
6788 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006789 LogObjectList objlist(cb_state->commandBuffer());
6790 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006791 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 -06006792 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6793 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006794 }
6795 return skip;
6796}
6797
6798// Validates the buffer is allowed to be protected
6799bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006800 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006801 bool skip = false;
6802 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006803 LogObjectList objlist(cb_state->commandBuffer());
6804 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006805 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 -06006806 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6807 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006808 }
6809 return skip;
6810}
6811
6812// Validates the buffer is allowed to be unprotected
6813bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006814 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006815 bool skip = false;
6816 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006817 LogObjectList objlist(cb_state->commandBuffer());
6818 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006819 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 -06006820 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6821 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006822 }
6823 return skip;
6824}