blob: 3915113ff8519f2cdb0a3fc179120e53b2a5e8cd [file] [log] [blame]
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001/* Copyright (c) 2015-2021 The Khronos Group Inc.
2 * Copyright (c) 2015-2021 Valve Corporation
3 * Copyright (c) 2015-2021 LunarG, Inc.
4 * Copyright (C) 2015-2021 Google Inc.
Tony-LunarG5a066372021-01-21 10:31:34 -07005 * Modifications Copyright (C) 2020-2021 Advanced Micro Devices, Inc. All rights reserved.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07006 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060020 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070021 * Shannon McPherson <shannon@lunarg.com>
Tobias Hector6663c9b2020-11-05 10:18:02 +000022 * Author: Tobias Hector <tobias.hector@amd.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070023 */
24
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Jeremy Gebben579aaca2021-02-15 13:36:18 -070029#include <iostream>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070040#include "core_error_location.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070041#include "shader_validation.h"
42#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070043#include "buffer_validation.h"
Jeremy Gebben7ba56152021-06-18 10:40:10 -060044#include "sync_utils.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070045#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070046
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070047// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070048static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070049 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070050 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
51 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
53 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
54 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
55 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
56 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070057 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070058 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
59 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
60 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
61 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
62 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070063 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070064 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
65 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
66 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
67 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
68 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070069 {"00197", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070070 "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
71 "VUID-vkCmdCopyImageToBuffer-imageOffset-00197",
72 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00197",
73 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
74 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070075 {"00198", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070076 "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
77 "VUID-vkCmdCopyImageToBuffer-imageOffset-00198",
78 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00198",
79 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
80 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070081 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070082 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
83 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
84 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
85 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
86 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070087 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070088 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
89 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
90 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
91 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
92 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070093 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070094 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
95 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
96 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
97 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
98 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070099 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700100 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
101 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
102 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
103 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
104 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700105 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700106 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
107 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
108 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
109 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
110 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700111 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700112 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
113 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
114 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
115 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
116 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700117 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700118 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
119 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
120 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
121 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
122 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700123 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700124 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
125 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
126 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
127 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
128 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700129 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700130 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
131 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
132 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
133 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
134 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700135 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700136 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
137 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
138 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
139 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
140 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700141 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700142 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
143 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
144 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
145 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
146 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700147 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700148 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
149 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
150 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
151 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
152 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700153 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700154 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
155 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
156 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
157 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800158 }},
159 {"04052", {
160 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
161 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
162 "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04052",
163 "VUID-VkCopyImageToBufferInfo2KHR-commandBuffer-04052",
164 }},
165 {"04053", {
166 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
167 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
168 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-04053",
169 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700170 }}
171 };
172 // clang-format on
173
174 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700175 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
176 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700177 return copy_imagebuffer_vuid.at(id).at(index);
178}
179
David McFarland2853f2f2020-11-30 15:50:39 -0400180// Transfer VkImageSubresourceRange into VkImageSubresourceLayers struct
181static VkImageSubresourceLayers LayersFromRange(const VkImageSubresourceRange &subresource_range) {
182 VkImageSubresourceLayers subresource_layers;
183 subresource_layers.aspectMask = subresource_range.aspectMask;
184 subresource_layers.baseArrayLayer = subresource_range.baseArrayLayer;
185 subresource_layers.layerCount = subresource_range.layerCount;
186 subresource_layers.mipLevel = subresource_range.baseMipLevel;
187 return subresource_layers;
188}
189
John Zulauff660ad62019-03-23 07:16:05 -0600190// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
191static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
192 VkImageSubresourceRange subresource_range;
193 subresource_range.aspectMask = subresource_layers.aspectMask;
194 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
195 subresource_range.layerCount = subresource_layers.layerCount;
196 subresource_range.baseMipLevel = subresource_layers.mipLevel;
197 subresource_range.levelCount = 1;
198 return subresource_range;
199}
200
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700201static VkImageLayout NormalizeImageLayout(VkImageLayout layout, VkImageLayout non_normal, VkImageLayout normal) {
202 return (layout == non_normal) ? normal : layout;
203}
204
205static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
206 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
207 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL);
208}
209
210static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
211 return NormalizeImageLayout(layout, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
212 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL);
213}
214
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700215static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
216 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
217 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
218 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
219 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
220 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
221 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
222 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
223 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
224 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
225 }
226 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
227 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
228 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
229 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
230 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
231 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
232 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
233 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
234 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
235 }
236 }
237 return layout;
238}
239
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700240static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
241 bool matches = (a == b);
242 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700243 a = NormalizeSynchronization2Layout(aspect_mask, a);
244 b = NormalizeSynchronization2Layout(aspect_mask, b);
245 matches = (a == b);
246 if (!matches) {
247 // Relaxed rules when referencing *only* the depth or stencil aspects
248 if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
249 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
250 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
251 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
252 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700253 }
254 }
255 return matches;
256}
257
258// Utility type for ForRange callbacks
259struct LayoutUseCheckAndMessage {
260 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
261 const ImageSubresourceLayoutMap *layout_map;
262 const VkImageAspectFlags aspect_mask;
263 const char *message;
264 VkImageLayout layout;
265
266 LayoutUseCheckAndMessage() = delete;
267 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
268 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
269 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
270 message = nullptr;
271 layout = kInvalidLayout; // Success status
272 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
273 message = "previous known";
274 layout = current_layout;
275 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
276 // To check the relaxed rule matching we need to see how the initial use was used
277 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
278 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
279 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
280 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
281 message = "previously used";
282 layout = initial_layout;
283 }
284 }
285 return layout == kInvalidLayout;
286 }
287};
288
locke-lunarg540b2252020-08-03 13:23:36 -0600289bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600290 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600291 return true;
292 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600293 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600294 return false;
295 }
locke-lunarg540b2252020-08-03 13:23:36 -0600296 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
297 return false;
298 }
299
300 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600301 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600302 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600303 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600304 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600305 }
306
307 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600308 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600309 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600310 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600311 }
312
313 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600314 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600315 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600316 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600317 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600318 }
319
320 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600321 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600322 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600323 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600324 }
locke-lunargdc287022020-08-21 12:03:57 -0600325 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600326}
327
Dave Houltond9611312018-11-19 17:03:36 -0700328uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
329 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700330 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700331}
332
333uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
334
335uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
336
John Zulauf2d60a452021-03-04 15:12:03 -0700337bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600338 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state.image());
John Zulauf2076e812020-01-08 14:55:54 -0700339 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700340 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
341 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
342
John Zulauf2076e812020-01-08 14:55:54 -0700343 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
344
345 // 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 -0700346 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700347 return false;
348 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700349
John Zulauf79f06582021-02-27 18:38:39 -0700350 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700351 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700352 }
353 return true;
354}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700355
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600356// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600357void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600358 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
359 VkImageLayout expected_layout) {
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600360 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state);
John Zulauff660ad62019-03-23 07:16:05 -0600361 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600362 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600363 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700364 }
John Zulaufd13b38e2021-03-05 08:17:38 -0700365 for (const auto *alias_state : image_state.aliasing_images) {
366 assert(alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700367 // 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 -0600368 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700369 assert(subresource_map);
370 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
371 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700372}
John Zulauff660ad62019-03-23 07:16:05 -0600373
374// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600375void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600376 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500377 return;
378 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500379 IMAGE_STATE *image_state = view_state.image_state.get();
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600380 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700381 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulaufd13b38e2021-03-05 08:17:38 -0700382 for (const auto *alias_state : image_state->aliasing_images) {
383 assert(alias_state);
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600384 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700385 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
386 }
John Zulauff660ad62019-03-23 07:16:05 -0600387}
388
389// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600390void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600391 const VkImageSubresourceRange &range, VkImageLayout layout) {
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600392 auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state);
John Zulauff660ad62019-03-23 07:16:05 -0600393 assert(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600394 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, image_state.NormalizeSubresourceRange(range), layout);
John Zulaufd13b38e2021-03-05 08:17:38 -0700395 for (const auto *alias_state : image_state.aliasing_images) {
396 assert(alias_state);
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600397 subresource_map = cb_node->GetImageSubresourceLayoutMap(*alias_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700398 assert(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600399 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, alias_state->NormalizeSubresourceRange(range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700400 }
John Zulauff660ad62019-03-23 07:16:05 -0600401}
402
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600403void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600404 VkImageLayout layout) {
405 const IMAGE_STATE *image_state = GetImageState(image);
406 if (!image_state) return;
407 SetImageInitialLayout(cb_node, *image_state, range, layout);
408};
409
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600410void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600411 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
412 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600413}
Dave Houltonddd65c52018-05-08 14:58:01 -0600414
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600415// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700416void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
417 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500418 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600419
John Zulauff660ad62019-03-23 07:16:05 -0600420 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600421 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
422 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600423 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 -0600424 sub_range.baseArrayLayer = 0;
425 sub_range.layerCount = image_state->createInfo.extent.depth;
426 }
427
Piers Daniell4fde9b72019-11-27 16:19:46 -0700428 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
429 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
430 SetImageLayout(cb_node, *image_state, sub_range, layout);
431 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
432 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
433 } else {
434 SetImageLayout(cb_node, *image_state, sub_range, layout);
435 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600436}
437
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700438bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
439 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700440 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600441 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100442 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700443 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100444 const char *vuid;
445 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700446 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100447
448 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600449 LogObjectList objlist(image);
450 objlist.add(renderpass);
451 objlist.add(framebuffer);
452 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700453 skip |=
454 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
455 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
456 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
457 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100458 return skip;
459 }
460
461 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700462 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200463 if (stencil_usage_info) {
464 image_usage |= stencil_usage_info->stencilUsage;
465 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466
467 // Check for layouts that mismatch image usages in the framebuffer
468 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800469 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600470 LogObjectList objlist(image);
471 objlist.add(renderpass);
472 objlist.add(framebuffer);
473 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700474 skip |= LogError(objlist, vuid,
475 "%s: Layout/usage mismatch for attachment %u in %s"
476 " - the %s is %s but the image attached to %s via %s"
477 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
478 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
479 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
480 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 }
482
483 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
484 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800485 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600486 LogObjectList objlist(image);
487 objlist.add(renderpass);
488 objlist.add(framebuffer);
489 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700490 skip |= LogError(objlist, vuid,
491 "%s: Layout/usage mismatch for attachment %u in %s"
492 " - the %s is %s but the image attached to %s via %s"
493 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
494 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
495 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
496 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100497 }
498
499 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800500 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600501 LogObjectList objlist(image);
502 objlist.add(renderpass);
503 objlist.add(framebuffer);
504 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700505 skip |= LogError(objlist, vuid,
506 "%s: Layout/usage mismatch for attachment %u in %s"
507 " - the %s is %s but the image attached to %s via %s"
508 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
509 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
510 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
511 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100512 }
513
514 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800515 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600516 LogObjectList objlist(image);
517 objlist.add(renderpass);
518 objlist.add(framebuffer);
519 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700520 skip |= LogError(objlist, vuid,
521 "%s: Layout/usage mismatch for attachment %u in %s"
522 " - the %s is %s but the image attached to %s via %s"
523 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
524 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
525 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
526 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100527 }
528
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600529 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100530 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
531 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
532 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
533 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
534 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800535 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600536 LogObjectList objlist(image);
537 objlist.add(renderpass);
538 objlist.add(framebuffer);
539 objlist.add(image_view);
540 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700541 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700542 " - the %s is %s but the image attached to %s via %s"
543 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700544 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700545 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
546 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100547 }
548 } else {
549 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
550 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
551 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
552 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600553 LogObjectList objlist(image);
554 objlist.add(renderpass);
555 objlist.add(framebuffer);
556 objlist.add(image_view);
557 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700558 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700559 " - the %s is %s but the image attached to %s via %s"
560 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700561 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700562 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
563 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100564 }
565 }
566 return skip;
567}
568
John Zulauf17a01bb2019-08-09 16:41:19 -0600569bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700570 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600571 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600572 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700573 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
574 auto const &framebuffer_info = framebuffer_state->createInfo;
575 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100576
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600577 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass();
578 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100579
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700580 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600581 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700582 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700583 }
John Zulauf8e308292018-09-21 11:34:37 -0600584
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700585 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800586 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700587 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100588 }
589
Tobias Hectorc9057422019-07-23 12:15:52 +0100590 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700591 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
592 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100593 auto image_view = attachments[i];
594 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100595
Tobias Hectorc9057422019-07-23 12:15:52 +0100596 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600597 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600598 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600599 objlist.add(image_view);
600 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700601 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600602 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700603 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100604 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100605 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100606
607 const VkImage image = view_state->create_info.image;
608 const IMAGE_STATE *image_state = GetImageState(image);
609
610 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600611 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600612 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600613 objlist.add(image_view);
614 objlist.add(image);
615 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700616 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600617 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700618 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100619 continue;
620 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700621 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
622 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100623
Piers Daniell7f894f62020-01-09 16:33:48 -0700624 // Default to expecting stencil in the same layout.
625 auto attachment_stencil_initial_layout = attachment_initial_layout;
626
627 // If a separate layout is specified, look for that.
628 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700629 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700630 if (attachment_description_stencil_layout) {
631 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
632 }
633
Tobias Hectorc9057422019-07-23 12:15:52 +0100634 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
635 // in common with the non-const version.)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700636 const ImageSubresourceLayoutMap *subresource_map = (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED)
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600637 ? const_p_cb->GetImageSubresourceLayoutMap(image)
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700638 : nullptr;
Tobias Hectorc9057422019-07-23 12:15:52 +0100639
640 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
641 LayoutUseCheckAndMessage layout_check(subresource_map);
642 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700643 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700644 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
645 // the next "constant value" range
646 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700647 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700648
John Zulauf5e617452019-11-19 14:44:16 -0700649 // Allow for differing depth and stencil layouts
650 VkImageLayout check_layout = attachment_initial_layout;
651 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
652
653 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700654 subres_skip |= LogError(
655 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700656 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
657 "and the %s layout of the attachment is %s. The layouts must match, or the render "
658 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700659 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100660 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700661 }
John Zulauf5e617452019-11-19 14:44:16 -0700662
Tobias Hectorc9057422019-07-23 12:15:52 +0100663 skip |= subres_skip;
664 }
665
666 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
667 framebuffer, render_pass, i, "initial layout");
668
669 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
670 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100671 }
672
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700673 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
674 auto &subpass = render_pass_info->pSubpasses[j];
675 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100676 auto &attachment_ref = subpass.pInputAttachments[k];
677 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
678 auto image_view = attachments[attachment_ref.attachment];
679 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100680
Tobias Hectorc9057422019-07-23 12:15:52 +0100681 if (view_state) {
682 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700683 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
684 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100685 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100686 }
687 }
688 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100689
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700690 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100691 auto &attachment_ref = subpass.pColorAttachments[k];
692 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
693 auto image_view = attachments[attachment_ref.attachment];
694 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100695
Tobias Hectorc9057422019-07-23 12:15:52 +0100696 if (view_state) {
697 auto image = view_state->create_info.image;
698 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
699 framebuffer, render_pass, attachment_ref.attachment,
700 "color attachment layout");
701 if (subpass.pResolveAttachments) {
702 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
703 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
704 attachment_ref.attachment, "resolve attachment layout");
705 }
706 }
707 }
708 }
709
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700710 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100711 auto &attachment_ref = *subpass.pDepthStencilAttachment;
712 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
713 auto image_view = attachments[attachment_ref.attachment];
714 auto view_state = GetImageViewState(image_view);
715
716 if (view_state) {
717 auto image = view_state->create_info.image;
718 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
719 framebuffer, render_pass, attachment_ref.attachment,
720 "input attachment layout");
721 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100722 }
723 }
724 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700725 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600726 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700727}
728
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600729void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700730 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700731 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600732 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600733 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700734 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700735 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700736 if (attachment_reference_stencil_layout) {
737 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
738 }
739
740 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600741 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700742 }
743}
744
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600745void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
746 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700747 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700748
749 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700750 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700751 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700752 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700753 }
754 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700755 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700756 }
757 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700758 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700759 }
760 }
761}
762
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700763// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
764// 1. Transition into initialLayout state
765// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600766void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700767 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700768 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700769 auto const rpci = render_pass_state->createInfo.ptr();
770 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600771 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600772 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700773 IMAGE_STATE *image_state = view_state->image_state.get();
774 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700775 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700776 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700777 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700778 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
779 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
780 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
781 SetImageInitialLayout(cb_state, *image_state, sub_range, initial_layout);
782 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
783 SetImageInitialLayout(cb_state, *image_state, sub_range, stencil_initial_layout);
784 } else {
785 SetImageInitialLayout(cb_state, *image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700786 }
John Zulauf8e308292018-09-21 11:34:37 -0600787 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700788 }
789 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700790 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700791}
792
Dave Houlton10b39482017-03-16 13:18:15 -0600793bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600794 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600795 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600796 }
797 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600798 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600799 }
800 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600801 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600802 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800803 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 -0700804 if (FormatPlaneCount(format) == 1) return false;
805 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600806 return true;
807}
808
Mike Weiblen62d08a32017-03-07 22:18:27 -0700809// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700810bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700811 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700812 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700813 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700814 switch (layout) {
815 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700816 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700817 break;
818 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700819 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700820 break;
821 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700822 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700823 break;
824 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700825 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700826 break;
827 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700828 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700829 break;
830 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700831 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700832 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600833 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700834 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500835 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700836 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700837 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700838 break;
839 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700840 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700841 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700842 default:
843 // Other VkImageLayout values do not have VUs defined in this context.
844 break;
845 }
846
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700847 if (is_error) {
848 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
849
850 skip |=
851 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
852 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700853 }
854 return skip;
855}
856
857// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700858template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700859bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700860 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700861 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700862 using sync_vuid_maps::GetImageBarrierVUID;
863 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200864 // Scoreboard for checking for duplicate and inconsistent barriers to images
865 struct ImageBarrierScoreboardEntry {
866 uint32_t index;
867 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
868 // 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 -0700869 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +0200870 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700871 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
872 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
873 // when creating maps full of maps.
874 struct ImageBarrierScoreboardSubresMap {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700875 layer_data::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700876 };
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700877 using ImageBarrierScoreboardImageMap = layer_data::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
Petr Krausad0096a2019-08-09 18:35:04 +0200878
John Zulauf463c51e2018-05-31 13:29:20 -0600879 // Scoreboard for duplicate layout transition barriers within the list
880 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
881 ImageBarrierScoreboardImageMap layout_transitions;
882
Mike Weiblen62d08a32017-03-07 22:18:27 -0700883 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700884 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200885 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700886
John Zulauf463c51e2018-05-31 13:29:20 -0600887 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
888 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
889 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200890 if (img_barrier.oldLayout != img_barrier.newLayout) {
891 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
892 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600893 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700894 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +0200895 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600896 if (subres_it != subres_map.end()) {
897 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700898 auto entry_layout =
899 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
900 auto old_layout =
901 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
902 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200903 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700904 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700905 skip = LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600906 cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700907 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600908 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
909 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700910 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +0200911 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
912 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600913 }
914 entry = new_entry;
915 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200916 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600917 }
918 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700919 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600920 }
921 }
922
Petr Krausad0096a2019-08-09 18:35:04 +0200923 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600924 if (image_state) {
925 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700926 skip |=
927 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
928 skip |=
929 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600930
931 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
932 if (image_state->layout_locked) {
933 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700934 skip |= LogError(
935 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700936 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600937 " 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 -0700938 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
939 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600940 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600941
John Zulaufa4472282019-08-22 14:44:34 -0600942 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700943 const VkFormat image_format = image_create_info.format;
944 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600945 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700946 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700947 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700948 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600949 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700950 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
951 skip |= LogError(img_barrier.image, vuid,
952 "%s references %s of format %s that must have either the depth or stencil "
953 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
954 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
955 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600956 }
957 } else {
958 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
959 if ((aspect_mask & ds_mask) != (ds_mask)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700960 auto error = device_extensions.vk_khr_separate_depth_stencil_layouts
961 ? ImageError::kNotSeparateDepthAndStencilAspect
962 : ImageError::kNotDepthAndStencilAspect;
963 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700964 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700965 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700966 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700967 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700968 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600969 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700970 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700971 }
John Zulauff660ad62019-03-23 07:16:05 -0600972
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600973 const auto *subresource_map = cb_state->GetImageSubresourceLayoutMap(img_barrier.image);
Petr Krausad0096a2019-08-09 18:35:04 +0200974 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600975 // TODO: Set memory invalid which is in mem_tracker currently
976 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
977 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600978 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600979 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600980 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -0600981 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -0700982 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
983 // the next "constant value" range
984 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700985 const auto &value = *pos;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700986 auto old_layout =
987 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
988 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700989 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600990 subres_skip = LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700991 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
992 "%s layout is %s.",
993 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
994 value.subresource.aspectMask, value.subresource.mipLevel,
995 value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
996 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600997 }
John Zulauf5e617452019-11-19 14:44:16 -0700998 }
John Zulauff660ad62019-03-23 07:16:05 -0600999 skip |= subres_skip;
1000 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001001
1002 // checks color format and (single-plane or non-disjoint)
1003 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1004 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001005 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001006 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001007 auto error = device_extensions.vk_khr_sampler_ycbcr_conversion ? ImageError::kNotColorAspect
1008 : ImageError::kNotColorAspectYcbcr;
1009 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -07001010 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001011 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -07001012 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001013 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001014 string_VkFormat(image_format), aspect_mask);
1015 }
1016 }
1017
1018 VkImageAspectFlags valid_disjoint_mask =
1019 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 -07001020 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001021 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001022 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1023 skip |= LogError(img_barrier.image, vuid,
1024 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -07001025 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001026 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001027 string_VkFormat(image_format), aspect_mask);
1028 }
1029
1030 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001031 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1032 skip |= LogError(img_barrier.image, vuid,
1033 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -07001034 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001035 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001036 string_VkFormat(image_format), aspect_mask);
1037 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001038 }
1039 }
1040 return skip;
1041}
1042
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001043template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001044bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001045 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001046 bool skip = false;
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;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001053 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001054 const auto found = barrier_sets.release.find(barrier);
1055 if (found != barrier_sets.release.cend()) {
1056 barrier_record = &(*found);
1057 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001058 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001059 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001060 const auto found = barrier_sets.acquire.find(barrier);
1061 if (found != barrier_sets.acquire.cend()) {
1062 barrier_record = &(*found);
1063 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001064 }
1065 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001066 if (barrier_record != nullptr) {
1067 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001068 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001069 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1070 " duplicates existing barrier recorded in this command buffer.",
1071 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1072 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1073 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001074 return skip;
1075}
1076
John Zulaufa4472282019-08-22 14:44:34 -06001077VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1078 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1079}
1080
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001081VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1082 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1083}
1084
John Zulaufa4472282019-08-22 14:44:34 -06001085const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1086 return device_state.GetImageState(barrier.image);
1087}
1088
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001089const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1090 return device_state.GetImageState(barrier.image);
1091}
1092
John Zulaufa4472282019-08-22 14:44:34 -06001093VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1094 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1095}
1096
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001097VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1098 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1099}
1100
John Zulaufa4472282019-08-22 14:44:34 -06001101const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1102 return device_state.GetBufferState(barrier.buffer);
1103}
1104
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001105const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1106 return device_state.GetBufferState(barrier.buffer);
1107}
John Zulaufa4472282019-08-22 14:44:34 -06001108
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001109template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001110void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001111 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001112 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001113 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001114 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001115 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001116 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001117 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001118 }
John Zulaufa4472282019-08-22 14:44:34 -06001119
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001120 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1121 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001122 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1123 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001124 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1125
1126 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001127 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1128 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1129 auto handle_state = BarrierHandleState(*this, barrier);
1130 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1131 if (!mode_concurrent) {
1132 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001133 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001134 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001135 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1136 const QUEUE_STATE *queue_state) {
1137 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001138 src_queue_family, dst_queue_family);
1139 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001140 }
1141 }
1142}
1143
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001144// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001145template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001146bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001147 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1148 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001149 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1150 using sync_vuid_maps::GetImageBarrierVUID;
1151 using sync_vuid_maps::ImageError;
1152
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001153 bool skip = false;
1154 const auto *fb_state = framebuffer;
1155 assert(fb_state);
1156 const auto img_bar_image = img_barrier.image;
1157 bool image_match = false;
1158 bool sub_image_found = false; // Do we find a corresponding subpass description
1159 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1160 uint32_t attach_index = 0;
1161 // Verify that a framebuffer image matches barrier image
1162 const auto attachment_count = fb_state->createInfo.attachmentCount;
1163 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001164 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001165 if (view_state && (img_bar_image == view_state->create_info.image)) {
1166 image_match = true;
1167 attach_index = attachment;
1168 break;
1169 }
1170 }
1171 if (image_match) { // Make sure subpass is referring to matching attachment
1172 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1173 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1174 sub_image_found = true;
1175 }
1176 if (!sub_image_found && device_extensions.vk_khr_depth_stencil_resolve) {
1177 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1178 if (resolve && resolve->pDepthStencilResolveAttachment &&
1179 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1180 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1181 sub_image_found = true;
1182 }
1183 }
1184 if (!sub_image_found) {
1185 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1186 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1187 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1188 sub_image_found = true;
1189 break;
1190 }
1191 if (!sub_image_found && sub_desc.pResolveAttachments &&
1192 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1193 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1194 sub_image_found = true;
1195 break;
1196 }
1197 }
1198 }
1199 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001200 auto img_loc = loc.dot(Field::image);
1201 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1202 skip |=
1203 LogError(rp_handle, vuid,
1204 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1205 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1206 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001207 }
1208 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001209 auto img_loc = loc.dot(Field::image);
1210 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001211 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 -07001212 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001213 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001214 }
1215 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001216 auto layout_loc = loc.dot(Field::oldLayout);
1217 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001218 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001219 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001220 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001221 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001222 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1223 } else {
1224 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1225 LogObjectList objlist(rp_handle);
1226 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001227 auto layout_loc = loc.dot(Field::oldLayout);
1228 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1229 skip |= LogError(objlist, vuid,
1230 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001231 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001232 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001233 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1234 string_VkImageLayout(img_barrier.oldLayout));
1235 }
1236 }
1237 return skip;
1238}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001239// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001240template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001241 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1242 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1243 const VkImageMemoryBarrier &img_barrier,
1244 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001245template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001246 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1247 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1248 const VkImageMemoryBarrier2KHR &img_barrier,
1249 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001250
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001251template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001252void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001253 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001254 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1255 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1256 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1257 const auto active_subpass = cb_state->activeSubpass;
1258 const auto rp_state = cb_state->activeRenderPass;
1259 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001260 // Secondary CB case w/o FB specified delay validation
1261 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001262 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001263 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001264 cb_state->cmd_execute_commands_functions.emplace_back(
1265 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1266 const FRAMEBUFFER_STATE *fb) {
1267 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1268 render_pass, barrier, primary_cb);
1269 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001270 }
1271}
1272
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001273void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001274 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1275 const VkImageMemoryBarrier *pImageMemBarriers) {
1276 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001277 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001278 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1279 }
1280 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001281 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001282 const auto &img_barrier = pImageMemBarriers[i];
1283 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1284 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1285 }
1286}
1287
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001288void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001289 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001290 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001291 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1292 }
1293 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001294 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001295 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1296 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1297 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1298 }
1299}
1300
1301template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001302bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001303 const char *operation, const TransferBarrier &barrier,
1304 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001305 // Record to the scoreboard or report that we have a duplication
1306 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001307 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001308 if (!inserted.second && inserted.first->second != cb_state) {
1309 // 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 -06001310 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001311 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001312 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001313 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001314 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1315 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001316 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001317 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001318 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001319 }
1320 return skip;
1321}
1322
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001323template <typename TransferBarrier>
1324bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1325 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1326 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001327 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001328 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001329 const char *barrier_name = TransferBarrier::BarrierName();
1330 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001331 // No release should have an extant duplicate (WARNING)
1332 for (const auto &release : cb_barriers.release) {
1333 // Check the global pending release barriers
1334 const auto set_it = global_release_barriers.find(release.handle);
1335 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001336 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001337 const auto found = set_for_handle.find(release);
1338 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001339 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001340 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1341 " to dstQueueFamilyIndex %" PRIu32
1342 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1343 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1344 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001345 }
1346 }
1347 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1348 }
1349 // Each acquire must have a matching release (ERROR)
1350 for (const auto &acquire : cb_barriers.acquire) {
1351 const auto set_it = global_release_barriers.find(acquire.handle);
1352 bool matching_release_found = false;
1353 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001354 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001355 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1356 }
1357 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001358 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001359 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1360 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1361 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1362 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001363 }
1364 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1365 }
1366 return skip;
1367}
1368
John Zulauf3b04ebd2019-07-18 14:08:11 -06001369bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001370 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1371 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001372 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001373 skip |=
1374 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1375 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1376 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001377 return skip;
1378}
1379
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001380template <typename TransferBarrier>
1381void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1382 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001383 // Add release barriers from this submit to the global map
1384 for (const auto &release : cb_barriers.release) {
1385 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1386 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1387 global_release_barriers[release.handle].insert(release);
1388 }
1389
1390 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1391 for (const auto &acquire : cb_barriers.acquire) {
1392 // NOTE: We're not using [] because we don't want to create entries for missing releases
1393 auto set_it = global_release_barriers.find(acquire.handle);
1394 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001395 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001396 set_for_handle.erase(acquire);
1397 if (set_for_handle.size() == 0) { // Clean up empty sets
1398 global_release_barriers.erase(set_it);
1399 }
1400 }
1401 }
1402}
1403
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001404void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001405 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1406 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1407 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001408}
1409
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001410template <typename ImgBarrier>
1411void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1412 // For ownership transfers, the barrier is specified twice; as a release
1413 // operation on the yielding queue family, and as an acquire operation
1414 // on the acquiring queue family. This barrier may also include a layout
1415 // transition, which occurs 'between' the two operations. For validation
1416 // purposes it doesn't seem important which side performs the layout
1417 // transition, but it must not be performed twice. We'll arbitrarily
1418 // choose to perform it as part of the acquire operation.
1419 //
1420 // However, we still need to record initial layout for the "initial layout" validation
1421 for (uint32_t i = 0; i < barrier_count; i++) {
1422 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001423 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001424 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001425 if (image_state) {
1426 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1427 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001428 }
1429}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001430// explictly instantiate this template so it can be used in core_validation.cpp
1431template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1432 const VkImageMemoryBarrier *barrier);
1433template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1434 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001435
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001436VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1437
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001438template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001439void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001440 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001441 if (enabled_features.synchronization2_features.synchronization2) {
1442 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1443 return;
1444 }
1445 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001446 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001447 const auto &image_create_info = image_state->createInfo;
1448
Mike Schuchardt2df08912020-12-15 16:28:09 -08001449 // 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 -07001450 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
unknown86bcb3a2019-07-11 13:05:36 -06001451 // for all (potential) layer sub_resources.
Mike Schuchardt2df08912020-12-15 16:28:09 -08001452 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
unknown86bcb3a2019-07-11 13:05:36 -06001453 normalized_isr.baseArrayLayer = 0;
1454 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1455 }
1456
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001457 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1458 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001459
1460 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001461 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001462 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1463 }
1464
John Zulauf2be3fe02019-12-30 09:48:02 -07001465 if (is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001466 SetImageInitialLayout(cb_state, *image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001467 } else {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001468 SetImageLayout(cb_state, *image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001469 }
unknown86bcb3a2019-07-11 13:05:36 -06001470}
1471
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001472bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1473 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1474 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1475 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001476 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001477 assert(cb_node);
1478 assert(image_state);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001479 const auto image = image_state->image();
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001480 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001481
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001482 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image);
John Zulauff660ad62019-03-23 07:16:05 -06001483 if (subresource_map) {
1484 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001485 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001486 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1487 // the next "constant value" range
1488 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001489 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001490 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001491 subres_skip |= LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001492 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1493 "%s layout %s.",
1494 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1495 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1496 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001497 }
John Zulauf5e617452019-11-19 14:44:16 -07001498 }
John Zulauff660ad62019-03-23 07:16:05 -06001499 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001500 }
John Zulauff660ad62019-03-23 07:16:05 -06001501
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001502 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1503 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1504 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001505 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1506 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001507 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001508 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1509 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001510 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001511 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001512 if (image_state->shared_presentable) {
1513 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001514 skip |=
1515 LogError(device, layout_invalid_msg_code,
1516 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1517 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001518 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001519 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001520 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001521 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001522 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001523 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1524 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1525 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001526 }
1527 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001528 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001529}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001530bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001531 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1532 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001533 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001534 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1535 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1536}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001537
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001538void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001539 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001540 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1541 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001542
Mike Schuchardt2df08912020-12-15 16:28:09 -08001543 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001544 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001545 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001546 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001547 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001548 VkImageLayout stencil_layout = kInvalidLayout;
1549 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001550 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001551 if (attachment_description_stencil_layout) {
1552 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1553 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001554 SetImageViewLayout(pCB, *view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001555 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001556 }
1557 }
1558}
Dave Houltone19e20d2018-02-02 16:32:41 -07001559
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001560#ifdef VK_USE_PLATFORM_ANDROID_KHR
1561// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1562// This could also move into a seperate core_validation_android.cpp file... ?
1563
1564//
1565// AHB-specific validation within non-AHB APIs
1566//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001567bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001568 bool skip = false;
1569
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001570 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001571 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001572 if (0 != ext_fmt_android->externalFormat) {
1573 if (VK_FORMAT_UNDEFINED != create_info->format) {
1574 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001575 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1576 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1577 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001578 }
1579
1580 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001581 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1582 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1583 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001584 }
1585
1586 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001587 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1588 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001589 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001590 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001591 }
1592
1593 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001594 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1595 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1596 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001597 }
1598 }
1599
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001600 if ((0 != ext_fmt_android->externalFormat) &&
1601 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001602 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001603 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1604 ") which has "
1605 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1606 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001607 }
1608 }
1609
Dave Houltond9611312018-11-19 17:03:36 -07001610 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001611 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001612 skip |=
1613 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1614 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1615 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001616 }
1617 }
1618
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001619 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001620 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1621 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001622 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001623 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1624 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1625 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1626 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001627 }
1628
1629 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001630 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1631 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1632 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1633 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1634 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001635 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001636 }
1637
1638 return skip;
1639}
1640
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001641bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001642 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001643 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001644
1645 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001646 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001647 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1648 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001649 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001650 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001651 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001652
Dave Houltond9611312018-11-19 17:03:36 -07001653 // Chain must include a compatible ycbcr conversion
1654 bool conv_found = false;
1655 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001656 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001657 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001658 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001659 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001660 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001661 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001662 }
Dave Houltond9611312018-11-19 17:03:36 -07001663 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001664 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001665 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001666 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1667 "an externalFormat (%" PRIu64
1668 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1669 "with the same external format.",
1670 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001671 }
1672
1673 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001674 if (IsIdentitySwizzle(create_info->components) == false) {
1675 skip |= LogError(
1676 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1677 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1678 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1679 "= %s.",
1680 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1681 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001682 }
1683 }
Dave Houltond9611312018-11-19 17:03:36 -07001684
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001685 return skip;
1686}
1687
John Zulaufa26d3c82019-08-14 16:09:08 -06001688bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001689 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001690
John Zulaufa26d3c82019-08-14 16:09:08 -06001691 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001692 if (image_state != nullptr) {
1693 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1694 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1695 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1696 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1697 "bound to memory.");
1698 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001699 }
1700 return skip;
1701}
1702
1703#else
1704
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001705bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001706 return false;
1707}
1708
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001709bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001710
John Zulaufa26d3c82019-08-14 16:09:08 -06001711bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001712
1713#endif // VK_USE_PLATFORM_ANDROID_KHR
1714
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001715bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1716 bool skip = false;
1717
1718 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1719 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1720 const VkImageTiling image_tiling = pCreateInfo->tiling;
1721 const VkFormat image_format = pCreateInfo->format;
1722
1723 if (image_format == VK_FORMAT_UNDEFINED) {
1724 // VU 01975 states format can't be undefined unless an android externalFormat
1725#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001726 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001727 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1728 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1729 if (it != ahb_ext_formats_map.end()) {
1730 tiling_features = it->second;
1731 }
1732 }
1733#endif
1734 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1735 uint64_t drm_format_modifier = 0;
1736 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001737 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001738 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001739 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001740
1741 if (drm_explicit != nullptr) {
1742 drm_format_modifier = drm_explicit->drmFormatModifier;
1743 } else {
1744 // VUID 02261 makes sure its only explict or implict in parameter checking
1745 assert(drm_implicit != nullptr);
1746 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1747 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1748 }
1749 }
1750
1751 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1752 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1753 nullptr};
1754 format_properties_2.pNext = (void *)&drm_properties_list;
1755 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001756 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1757 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1758 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1759 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001760
1761 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1762 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1763 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1764 }
1765 }
1766 } else {
1767 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1768 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1769 : format_properties.optimalTilingFeatures;
1770 }
1771
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001772 // Lack of disjoint format feature support while using the flag
1773 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1774 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1775 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1776 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1777 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1778 string_VkFormat(pCreateInfo->format));
1779 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001780
1781 return skip;
1782}
1783
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001784bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001785 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001786 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001787
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001788 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001789 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001790 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1791 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001792 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1793 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001794 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001795 }
1796
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001797 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1798 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001799 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1800 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1801 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001802 }
1803
1804 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001805 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1806 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1807 "height (%d) and arrayLayers (%d) must be >= 6.",
1808 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001809 }
Dave Houlton130c0212018-01-29 13:39:56 -07001810 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001811
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001812 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001813 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1814 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1815 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001816 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001817 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1818 "device maxFramebufferWidth (%u).",
1819 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001820 }
1821
1822 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001823 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001824 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1825 "device maxFramebufferHeight (%u).",
1826 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001827 }
1828
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001829 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001830 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1831 static_cast<float>(device_limits->maxFramebufferWidth) /
1832 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001833 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1834 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001835 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1836 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1837 "ceiling of device "
1838 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1839 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1840 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001841 }
1842
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001843 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1844 static_cast<float>(device_limits->maxFramebufferHeight) /
1845 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001846 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1847 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001848 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1849 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1850 "ceiling of device "
1851 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1852 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1853 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001854 }
1855 }
1856
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001857 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001858 VkResult result = VK_SUCCESS;
1859 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1860 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1861 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1862 &format_limits);
1863 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001864 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1865 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001866 if (modifier_list) {
1867 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001868 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001869 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001870 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001871 image_format_info.type = pCreateInfo->imageType;
1872 image_format_info.format = pCreateInfo->format;
1873 image_format_info.tiling = pCreateInfo->tiling;
1874 image_format_info.usage = pCreateInfo->usage;
1875 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001876 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001877
1878 result =
1879 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1880 format_limits = image_format_properties.imageFormatProperties;
1881
1882 /* The application gives a list of modifier and the driver
1883 * selects one. If one is wrong, stop there.
1884 */
1885 if (result != VK_SUCCESS) break;
1886 }
1887 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001888 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001889 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001890 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001891 image_format_info.type = pCreateInfo->imageType;
1892 image_format_info.format = pCreateInfo->format;
1893 image_format_info.tiling = pCreateInfo->tiling;
1894 image_format_info.usage = pCreateInfo->usage;
1895 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001896 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001897
1898 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1899 format_limits = image_format_properties.imageFormatProperties;
1900 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001901 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001902
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001903 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1904 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1905 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1906 if (result != VK_SUCCESS) {
1907 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001908#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001909 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001910#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001911 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001912 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001913 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1914 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001915#ifdef VK_USE_PLATFORM_ANDROID_KHR
1916 }
1917#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001918 } else {
1919 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1920 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001921 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1922 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1923 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001924 }
Dave Houlton130c0212018-01-29 13:39:56 -07001925
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001926 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1927 static_cast<uint64_t>(pCreateInfo->extent.height) *
1928 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1929 static_cast<uint64_t>(pCreateInfo->samples);
1930 uint64_t total_size =
1931 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Dave Houlton130c0212018-01-29 13:39:56 -07001932
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001933 // Round up to imageGranularity boundary
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001934 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1935 uint64_t ig_mask = image_granularity - 1;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001936 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001937
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001938 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001939 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1940 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1941 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1942 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001943 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001944
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001945 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001946 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1947 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1948 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001949 }
1950
1951 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001952 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1953 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1954 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001955 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001956
1957 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1958 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1959 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1960 pCreateInfo->extent.width, format_limits.maxExtent.width);
1961 }
1962
1963 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1964 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1965 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1966 pCreateInfo->extent.height, format_limits.maxExtent.height);
1967 }
1968
1969 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1970 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1971 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1972 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1973 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001974 }
1975
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001976 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001977 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1978 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1979 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1980 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001981 skip |= LogError(device, error_vuid,
1982 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1983 "YCbCr Conversion format, arrayLayers must be 1",
1984 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001985 }
1986
1987 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001988 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1989 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1990 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001991 }
1992
1993 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001994 skip |= LogError(
1995 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001996 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1997 string_VkSampleCountFlagBits(pCreateInfo->samples));
1998 }
1999
2000 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002001 skip |= LogError(
2002 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08002003 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2004 string_VkImageType(pCreateInfo->imageType));
2005 }
2006 }
2007
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002008 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002009 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07002010 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06002011 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002012 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2013 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2014 "format must be block, ETC or ASTC compressed, but is %s",
2015 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002016 }
2017 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002018 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2019 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2020 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002021 }
2022 }
2023 }
2024
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002025 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002026 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
2027 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
2028 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002029 }
2030
unknown2c877272019-07-11 12:56:50 -06002031 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2032 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2033 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002034 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2035 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2036 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002037 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002038
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002039 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002040 if (swapchain_create_info != nullptr) {
2041 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2042 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2043 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2044
2045 // Validate rest of Swapchain Image create check that require swapchain state
2046 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2047 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2048 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2049 skip |= LogError(
2050 device, vuid,
2051 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2052 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2053 }
2054 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2055 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2056 skip |= LogError(device, vuid,
2057 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2058 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2059 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002060 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002061 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2062 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2063 skip |= LogError(device, vuid,
2064 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2065 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002066 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002067 }
2068 }
2069 }
2070
sfricke-samsungedce77a2020-07-03 22:35:13 -07002071 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2072 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2073 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2074 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2075 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2076 }
2077 const VkImageCreateFlags invalid_flags =
2078 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2079 if ((pCreateInfo->flags & invalid_flags) != 0) {
2080 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2081 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2082 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2083 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2084 }
2085 }
2086
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002087 skip |= ValidateImageFormatFeatures(pCreateInfo);
2088
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002089 // Check compatibility with VK_KHR_portability_subset
2090 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
2091 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2092 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2093 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2094 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2095 }
2096 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2097 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2098 skip |=
2099 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2100 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2101 }
2102 }
2103
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002104 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002105}
2106
John Zulauf7eeb6f72019-06-17 11:56:36 -06002107void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2108 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2109 if (VK_SUCCESS != result) return;
2110
2111 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002112 auto image_state = Get<IMAGE_STATE>(*pImage);
2113 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002114}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002115
Jeff Bolz5c801d12019-10-09 10:38:45 -05002116bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002117 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002118 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002119 if (image_state) {
sfricke-samsung9056cc12021-04-18 22:51:00 -07002120 if (image_state->is_swapchain_image) {
2121 // TODO - Add VUID when headers are upstreamed
2122 skip |= LogError(device, "UNASSIGNED-vkDestroyImage-image",
2123 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2124 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002125 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002126 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002127 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002128 }
2129 return skip;
2130}
2131
John Zulauf7eeb6f72019-06-17 11:56:36 -06002132void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2133 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002134 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002135
locke-lunargcba7d5f2019-12-30 16:59:11 -07002136 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002137
2138 // Clean up generic image state
2139 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002140}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002141
sfricke-samsungcd924d92020-05-20 23:51:17 -07002142bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2143 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002144 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002145 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002146 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002147
2148 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002149 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2150 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002151 }
2152
sfricke-samsungcd924d92020-05-20 23:51:17 -07002153 if (FormatIsDepthOrStencil(format)) {
2154 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2155 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2156 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2157 } else if (FormatIsCompressed(format)) {
2158 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2159 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2160 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002161 }
2162
2163 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002164 skip |=
2165 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2166 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2167 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002168 }
2169 return skip;
2170}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002171
John Zulauf07288512019-07-05 11:09:50 -06002172bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2173 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2174 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002175 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002176 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2177 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002178 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002179 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2180 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002181 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002182
2183 } else {
2184 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2185 if (!device_extensions.vk_khr_shared_presentable_image) {
2186 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002187 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002188 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2189 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002190 }
2191 } else {
2192 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2193 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002194 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002195 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002196 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2197 func_name, string_VkImageLayout(dest_image_layout));
2198 }
2199 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002200 }
2201
John Zulauff660ad62019-03-23 07:16:05 -06002202 // Cast to const to prevent creation at validate time.
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002203 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state->image());
John Zulauff660ad62019-03-23 07:16:05 -06002204 if (subresource_map) {
2205 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002206 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002207 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002208 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2209 // the next "constant value" range
2210 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002211 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002212 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2213 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2214 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2215 } else {
2216 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002217 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002218 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002219 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2220 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2221 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002222 }
John Zulauf5e617452019-11-19 14:44:16 -07002223 }
John Zulauff660ad62019-03-23 07:16:05 -06002224 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002225 }
2226
2227 return skip;
2228}
2229
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002230bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2231 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002232 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002233 bool skip = false;
2234 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002235 const auto *cb_node = GetCBState(commandBuffer);
2236 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002237 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002238 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002239 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002240 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002241 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2242 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002243 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002244 skip |=
2245 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2246 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2247 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002248 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002249 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002250 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002251 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002252 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002253 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002254 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2255 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2256 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2257 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2258 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2259 string_VkFormat(image_state->createInfo.format));
2260 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002261 }
2262 return skip;
2263}
2264
John Zulaufeabb4462019-07-05 14:13:03 -06002265void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2266 const VkClearColorValue *pColor, uint32_t rangeCount,
2267 const VkImageSubresourceRange *pRanges) {
2268 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2269
2270 auto cb_node = GetCBState(commandBuffer);
2271 auto image_state = GetImageState(image);
2272 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002273 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002274 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002275 }
2276 }
2277}
2278
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002279bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2280 const char *apiName) const {
2281 bool skip = false;
2282
2283 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
2284 if (!device_extensions.vk_ext_depth_range_unrestricted) {
2285 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2286 // Also VUID-VkClearDepthStencilValue-depth-00022
2287 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2288 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2289 "(=%f) is not within the [0.0, 1.0] range.",
2290 apiName, clearValue.depth);
2291 }
2292 }
2293
2294 return skip;
2295}
2296
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002297bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2298 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002299 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002300 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002301
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002302 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002303 const auto *cb_node = GetCBState(commandBuffer);
2304 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002305 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002306 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002307 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002308 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002309 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002310 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002311 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002312 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002313 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002314 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002315 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2316 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2317 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2318 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002319
2320 bool any_include_aspect_depth_bit = false;
2321 bool any_include_aspect_stencil_bit = false;
2322
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002323 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002324 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002325 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002326 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002327 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002328 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2329 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002330 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2331 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2332 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2333 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002334 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002335 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2336 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002337 if (FormatHasDepth(image_format) == false) {
2338 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2339 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2340 "doesn't have a depth component.",
2341 i, string_VkFormat(image_format));
2342 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002343 }
2344 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2345 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002346 if (FormatHasStencil(image_format) == false) {
2347 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2348 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2349 "%s doesn't have a stencil component.",
2350 i, string_VkFormat(image_format));
2351 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002352 }
2353 }
2354 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002355 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002356 if (image_stencil_struct != nullptr) {
2357 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2358 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002359 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2360 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2361 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2362 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002363 }
2364 } else {
2365 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002366 skip |= LogError(
2367 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002368 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2369 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2370 "in VkImageCreateInfo::usage used to create image");
2371 }
2372 }
2373 }
2374 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002375 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2376 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2377 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002378 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002379 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002380 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2381 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002382 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002383 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002384 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002385 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2386 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2387 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2388 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002389 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002390 }
2391 return skip;
2392}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002393
John Zulaufeabb4462019-07-05 14:13:03 -06002394void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2395 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2396 const VkImageSubresourceRange *pRanges) {
2397 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2398 auto cb_node = GetCBState(commandBuffer);
2399 auto image_state = GetImageState(image);
2400 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002401 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002402 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002403 }
2404 }
2405}
2406
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002407// Returns true if [x, xoffset] and [y, yoffset] overlap
2408static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2409 bool result = false;
2410 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2411 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2412
2413 if (intersection_max > intersection_min) {
2414 result = true;
2415 }
2416 return result;
2417}
2418
Jeff Leger178b1e52020-10-05 12:22:23 -04002419// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002420// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002421template <typename RegionType>
2422static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002423 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002424
Dave Houltonc991cc92018-03-06 11:08:51 -07002425 // Separate planes within a multiplane image cannot intersect
2426 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002427 return result;
2428 }
2429
Dave Houltonc991cc92018-03-06 11:08:51 -07002430 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2431 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2432 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002433 result = true;
2434 switch (type) {
2435 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002436 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002437 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002438 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002439 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002440 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002441 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002442 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002443 break;
2444 default:
2445 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2446 assert(false);
2447 }
2448 }
2449 return result;
2450}
2451
Dave Houltonfc1a4052017-04-27 14:32:45 -06002452// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002453static const uint32_t kXBit = 1;
2454static const uint32_t kYBit = 2;
2455static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002456static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002457 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002458 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002459 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2460 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002461 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002462 }
2463 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2464 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002465 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002466 }
2467 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2468 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002469 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002470 }
2471 return result;
2472}
2473
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474// Test if two VkExtent3D structs are equivalent
2475static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2476 bool result = true;
2477 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2478 (extent->depth != other_extent->depth)) {
2479 result = false;
2480 }
2481 return result;
2482}
2483
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002484// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002485static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002486 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2487}
2488
2489// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002490VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002491 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2492 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002493 auto pool = cb_node->command_pool.get();
2494 if (pool) {
2495 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002496 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002497 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 granularity.width *= block_size.width;
2499 granularity.height *= block_size.height;
2500 }
2501 }
2502 return granularity;
2503}
2504
2505// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2506static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2507 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002508 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2509 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002510 valid = false;
2511 }
2512 return valid;
2513}
2514
2515// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002516bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002517 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002518 bool skip = false;
2519 VkExtent3D offset_extent = {};
2520 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2521 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2522 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002523 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002524 // 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 -07002525 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002526 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002527 "%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 "
2528 "image transfer granularity is (w=0, h=0, d=0).",
2529 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002530 }
2531 } else {
2532 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2533 // integer multiples of the image transfer granularity.
2534 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002535 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002536 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2537 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2538 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2539 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002540 }
2541 }
2542 return skip;
2543}
2544
2545// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002546bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002547 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002548 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002549 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002550 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002551 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2552 // subresource extent.
2553 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002554 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2556 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2557 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2558 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002559 }
2560 } else {
2561 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2562 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2563 // subresource extent dimensions.
2564 VkExtent3D offset_extent_sum = {};
2565 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2566 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2567 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002568 bool x_ok = true;
2569 bool y_ok = true;
2570 bool z_ok = true;
2571 switch (image_type) {
2572 case VK_IMAGE_TYPE_3D:
2573 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2574 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002575 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002576 case VK_IMAGE_TYPE_2D:
2577 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2578 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002579 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002580 case VK_IMAGE_TYPE_1D:
2581 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2582 (subresource_extent->width == offset_extent_sum.width));
2583 break;
2584 default:
2585 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2586 assert(false);
2587 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002588 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002589 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002590 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002591 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2592 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2593 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2594 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2595 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2596 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002597 }
2598 }
2599 return skip;
2600}
2601
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002602bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002603 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002604 bool skip = false;
2605 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002606 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2607 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002608 }
2609 return skip;
2610}
2611
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002612bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002613 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002614 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002615 bool skip = false;
2616 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2617 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002618 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002619 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2620 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002621 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002622 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002623 }
2624 return skip;
2625}
2626
Jeff Leger178b1e52020-10-05 12:22:23 -04002627// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2628template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002629bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002630 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002631 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002632 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002633 VkExtent3D granularity = GetScaledItg(cb_node, img);
2634 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002635 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002636 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002637 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002638 return skip;
2639}
2640
Jeff Leger178b1e52020-10-05 12:22:23 -04002641// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2642template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002643bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002644 const IMAGE_STATE *dst_img, const RegionType *region,
2645 const uint32_t i, const char *function,
2646 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002647 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002648 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2649 const char *vuid;
2650
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002651 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002652 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002653 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2654 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002655 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002656 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002657 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002658 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002659 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002660
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002661 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002662 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002663 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2664 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002665 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002666 const VkExtent3D dest_effective_extent =
2667 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002668 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002669 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002670 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002671 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002672 return skip;
2673}
2674
Jeff Leger178b1e52020-10-05 12:22:23 -04002675// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2676template <typename ImageCopyRegionType>
2677bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2678 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2679 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002680 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002681 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2682 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2683 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002684
2685 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002686 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002687
2688 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002689 const VkExtent3D src_copy_extent = region.extent;
2690 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002691 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2692
Dave Houlton6f9059e2017-05-02 17:15:13 -06002693 bool slice_override = false;
2694 uint32_t depth_slices = 0;
2695
2696 // Special case for copying between a 1D/2D array and a 3D image
2697 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2698 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002699 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002700 slice_override = (depth_slices != 1);
2701 } 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 -07002702 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002703 slice_override = (depth_slices != 1);
2704 }
2705
2706 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002707 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002708 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002709 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002710 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002711 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2712 "be 0 and 1, respectively.",
2713 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002714 }
2715 }
2716
Dave Houlton533be9f2018-03-26 17:08:30 -06002717 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 -04002718 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002719 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002720 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002721 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002722 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002723 }
2724
Dave Houlton533be9f2018-03-26 17:08:30 -06002725 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002726 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002727 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 -04002728 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002729 }
2730
Dave Houltonc991cc92018-03-06 11:08:51 -07002731 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002732 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002733 if (FormatIsCompressed(src_state->createInfo.format) ||
2734 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002735 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002736 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002737 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2738 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2739 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002740 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002741 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002742 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002743 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002744 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002745 }
2746
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002747 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002748 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2749 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002750 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002751 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002752 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2753 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2754 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002755 }
2756
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002757 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002758 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2759 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002760 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002761 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2763 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2764 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002765 }
2766
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002767 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002768 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2769 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002770 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002771 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002772 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2773 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2774 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002775 }
2776 } // Compressed
2777
2778 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002779 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002780 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002781 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002782 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002783 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002784 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002785 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002786 }
2787 }
2788
Dave Houlton533be9f2018-03-26 17:08:30 -06002789 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 -04002790 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002791 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002792 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2793 "and 1, respectively.",
2794 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002795 }
2796
Dave Houlton533be9f2018-03-26 17:08:30 -06002797 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002798 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002799 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 -04002800 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002801 }
2802
sfricke-samsung30b094c2020-05-30 11:42:11 -07002803 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002804 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002805 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2806 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002807 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002808 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002809 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2810 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2811 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002812 }
2813 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002814 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002815 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002816 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002817 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002818 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2819 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2820 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002821 }
2822 }
2823 } else { // Pre maint 1
2824 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002825 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002826 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002827 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002828 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002829 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2830 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002831 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002832 }
Dave Houltonee281a52017-12-08 13:51:02 -07002833 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002834 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002835 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002836 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002837 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2838 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002839 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002840 }
2841 }
2842 }
2843
Dave Houltonc991cc92018-03-06 11:08:51 -07002844 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2845 if (FormatIsCompressed(dst_state->createInfo.format) ||
2846 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002847 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002848
2849 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002850 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2851 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2852 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002853 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002854 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002856 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002857 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002858 }
2859
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002860 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002861 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2862 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002864 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002865 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2866 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2867 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002868 }
2869
Dave Houltonee281a52017-12-08 13:51:02 -07002870 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2871 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2872 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002873 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002874 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002875 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002876 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2877 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002878 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002879 }
2880
Dave Houltonee281a52017-12-08 13:51:02 -07002881 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2882 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2883 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002884 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
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] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2887 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2888 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002889 }
2890 } // Compressed
2891 }
2892 return skip;
2893}
2894
Jeff Leger178b1e52020-10-05 12:22:23 -04002895template <typename RegionType>
2896bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2897 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2898 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002899 const auto *cb_node = GetCBState(commandBuffer);
2900 const auto *src_image_state = GetImageState(srcImage);
2901 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002902 const VkFormat src_format = src_image_state->createInfo.format;
2903 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002904 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002905 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002906
Jeff Leger178b1e52020-10-05 12:22:23 -04002907 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2908 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2909 const char *vuid;
2910
2911 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002912
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002913 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002914
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002915 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002916 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002917
2918 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2919 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002920 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002921
Dave Houlton6f9059e2017-05-02 17:15:13 -06002922 bool slice_override = false;
2923 uint32_t depth_slices = 0;
2924
2925 // Special case for copying between a 1D/2D array and a 3D image
2926 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2927 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2928 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002929 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002930 slice_override = (depth_slices != 1);
2931 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2932 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002933 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002934 slice_override = (depth_slices != 1);
2935 }
2936
Jeff Leger178b1e52020-10-05 12:22:23 -04002937 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2938 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2939 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2940 skip |=
2941 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2942 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2943 skip |=
2944 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2945 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002946 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002947 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2948 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002949 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002950 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002951
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002952 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002953 // No chance of mismatch if we're overriding depth slice count
2954 if (!slice_override) {
2955 // The number of depth slices in srcSubresource and dstSubresource must match
2956 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2957 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002958 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2959 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002960 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002961 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2962 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002963 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002964 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2965 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002966 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2967 "do not match.",
2968 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002969 }
2970 }
2971 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002972 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002973 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002974 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002975 skip |=
2976 LogError(command_buffer, vuid,
2977 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2978 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002979 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002980 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002981
Dave Houltonc991cc92018-03-06 11:08:51 -07002982 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002983 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002984 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2985 // If neither image is multi-plane the aspectMask member of src and dst must match
2986 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2987 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2988 skip |= LogError(command_buffer, vuid,
2989 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2990 "source (0x%x) destination (0x%x).",
2991 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2992 }
2993 } else {
2994 // Source image multiplane checks
2995 uint32_t planes = FormatPlaneCount(src_format);
2996 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2997 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2998 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2999 skip |= LogError(command_buffer, vuid,
3000 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3001 i, aspect);
3002 }
3003 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3004 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3005 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
3006 skip |= LogError(command_buffer, vuid,
3007 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3008 i, aspect);
3009 }
3010 // Single-plane to multi-plane
3011 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3012 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3013 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3014 skip |= LogError(command_buffer, vuid,
3015 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3016 func_name, i, aspect);
3017 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003018
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003019 // Dest image multiplane checks
3020 planes = FormatPlaneCount(dst_format);
3021 aspect = region.dstSubresource.aspectMask;
3022 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3023 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3024 skip |= LogError(command_buffer, vuid,
3025 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3026 i, aspect);
3027 }
3028 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3029 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3030 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3031 skip |= LogError(command_buffer, vuid,
3032 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3033 i, aspect);
3034 }
3035 // Multi-plane to single-plane
3036 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3037 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3038 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3039 skip |= LogError(command_buffer, vuid,
3040 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3041 func_name, i, aspect);
3042 }
3043 }
3044 } else {
3045 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003046 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3047 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003048 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003049 skip |= LogError(
3050 command_buffer, vuid,
3051 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3052 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003053 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003054 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003055
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003056 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003057 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003058 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003059 skip |=
3060 LogError(command_buffer, vuid,
3061 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3062 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003063 }
3064
3065 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003066 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003067 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003068 skip |= LogError(
3069 command_buffer, vuid,
3070 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3071 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003072 }
3073
Dave Houltonfc1a4052017-04-27 14:32:45 -06003074 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003075 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003076 if (slice_override) src_copy_extent.depth = depth_slices;
3077 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003078 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003079 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3080 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003081 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003082 "width [%1d].",
3083 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003084 }
3085
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003086 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003087 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3088 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003089 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003090 "height [%1d].",
3091 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003092 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003093 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003094 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3095 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003096 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003097 "depth [%1d].",
3098 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003099 }
3100
Dave Houltonee281a52017-12-08 13:51:02 -07003101 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003102 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003103 if (slice_override) dst_copy_extent.depth = depth_slices;
3104
3105 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003106 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003107 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3108 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003109 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003110 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003111 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003112 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003113 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003114 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3115 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003116 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003117 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003118 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003119 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003120 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003121 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3122 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003123 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003124 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003125 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003126 }
3127
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003128 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3129 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003130 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003131 for (uint32_t j = 0; j < regionCount; j++) {
3132 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003133 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003134 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003135 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003136 }
3137 }
3138 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003139
3140 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3141 if (device_extensions.vk_khr_maintenance1) {
3142 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3143 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3144 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003145 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3146 skip |= LogError(command_buffer, vuid,
3147 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3148 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003149 }
3150 } else {
3151 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3152 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3153 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003154 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3155 skip |= LogError(command_buffer, vuid,
3156 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3157 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003158 }
3159 }
3160
3161 // Check if 2D with 3D and depth not equal to 2D layerCount
3162 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3163 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3164 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003165 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3166 skip |= LogError(command_buffer, vuid,
3167 "%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 -08003168 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003169 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003170 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3171 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3172 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003173 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3174 skip |= LogError(command_buffer, vuid,
3175 "%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 -08003176 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003177 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003178 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003179
3180 // Check for multi-plane format compatiblity
3181 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3182 size_t src_format_size = 0;
3183 size_t dst_format_size = 0;
3184 if (FormatIsMultiplane(src_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003185 const VkFormat plane_format = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3186 src_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003187 } else {
3188 src_format_size = FormatElementSize(src_format);
3189 }
3190 if (FormatIsMultiplane(dst_format)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003191 const VkFormat plane_format = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3192 dst_format_size = FormatElementSize(plane_format);
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003193 } else {
3194 dst_format_size = FormatElementSize(dst_format);
3195 }
3196 // If size is still zero, then format is invalid and will be caught in another VU
3197 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003198 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3199 skip |= LogError(command_buffer, vuid,
3200 "%s: pRegions[%u] called with non-compatible image formats. "
3201 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3202 func_name, i, string_VkFormat(src_format),
3203 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3204 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003205 }
3206 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003207 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003208
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003209 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3210 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3211 // because because both texels are 4 bytes in size.
3212 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003213 const char *compatible_vuid =
3214 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3215 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3216 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003217 // Depth/stencil formats must match exactly.
3218 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3219 if (src_format != dst_format) {
3220 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003221 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003222 string_VkFormat(src_format), string_VkFormat(dst_format));
3223 }
3224 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003225 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003226 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003227 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003228 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003229 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003230 FormatElementSize(dst_format));
3231 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003232 }
3233 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003234
Dave Houlton33c22b72017-02-28 13:16:02 -07003235 // Source and dest image sample counts must match
3236 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003237 std::stringstream ss;
3238 ss << func_name << " called on image pair with non-identical sample counts.";
3239 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003240 skip |=
3241 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3242 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3243 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003244 }
3245
Tony-LunarG5a066372021-01-21 10:31:34 -07003246 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3247 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3248 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003249 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
Tony-LunarG5a066372021-01-21 10:31:34 -07003250 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
3251 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3252 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3253 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003254 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003255 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3256 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3257 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3258 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3259 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3260 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3261 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3262 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3263 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3264 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3265 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3266 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003267
3268 // Validation for VK_EXT_fragment_density_map
3269 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003270 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3271 skip |=
3272 LogError(command_buffer, vuid,
3273 "%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 +02003274 }
3275 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003276 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3277 skip |=
3278 LogError(command_buffer, vuid,
3279 "%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 +02003280 }
3281
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003282 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003283 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3284 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3285 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3286 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003287 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003288 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003289 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003290
3291 const char *invalid_src_layout_vuid =
3292 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3293 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3294 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3295 const char *invalid_dst_layout_vuid =
3296 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3297 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3298 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3299
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003300 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003301 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003302 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003303 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3304 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003305 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003306 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003307 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003308 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003309 }
3310
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003311 return skip;
3312}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003313
Jeff Leger178b1e52020-10-05 12:22:23 -04003314bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3315 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3316 const VkImageCopy *pRegions) const {
3317 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3318 COPY_COMMAND_VERSION_1);
3319}
3320
3321bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3322 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3323 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3324 COPY_COMMAND_VERSION_2);
3325}
3326
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003327void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3328 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3329 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003330 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3331 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003332 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003333 auto src_image_state = GetImageState(srcImage);
3334 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003335
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003336 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003337 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003338 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3339 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003340 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003341}
3342
Jeff Leger178b1e52020-10-05 12:22:23 -04003343void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3344 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3345 auto cb_node = GetCBState(commandBuffer);
3346 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3347 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3348
3349 // Make sure that all image slices are updated to correct layout
3350 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3351 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3352 pCopyImageInfo->srcImageLayout);
3353 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3354 pCopyImageInfo->dstImageLayout);
3355 }
3356}
3357
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003358// Returns true if sub_rect is entirely contained within rect
3359static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3360 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 -07003361 (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 -07003362 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003363 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003364 return true;
3365}
3366
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003367bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003368 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003369 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3370 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003371 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003372 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3373 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003374 if (primary_cb_state) {
3375 image_view_state = primary_cb_state->GetActiveAttachmentImageViewState(fb_attachment);
3376 } else {
3377 image_view_state = GetCBState(command_buffer)->GetActiveAttachmentImageViewState(fb_attachment);
3378 }
John Zulauff2582972019-02-09 14:53:30 -07003379 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003380
3381 for (uint32_t j = 0; j < rect_count; j++) {
3382 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003383 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3384 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3385 "the current render pass instance.",
3386 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003387 }
3388
3389 if (image_view_state) {
3390 // The layers specified by a given element of pRects must be contained within every attachment that
3391 // pAttachments refers to
3392 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3393 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3394 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003395 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3396 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3397 "of pAttachment[%d].",
3398 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003399 }
3400 }
3401 }
3402 return skip;
3403}
3404
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003405bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3406 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003407 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003408 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003409 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003410 if (!cb_node) return skip;
3411
Petr Kraus2dffb382019-08-10 02:52:12 +02003412 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003413
3414 // Validate that attachment is in reference list of active subpass
3415 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003416 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003417 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003418 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003419 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003420 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003421
John Zulauf3a548ef2019-02-01 16:14:07 -07003422 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3423 auto clear_desc = &pAttachments[attachment_index];
3424 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003425 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003426
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003427 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3428 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3429 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3430 attachment_index);
3431 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3432 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3433 skip |=
3434 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3435 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3436 attachment_index);
3437 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003438 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3439 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3440 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3441 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003442 skip |= LogError(
3443 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3444 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3445 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3446 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003447 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003448 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003449
John Zulauff2582972019-02-09 14:53:30 -07003450 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3451 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003452 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003453 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3454 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3455 " subpass %u. colorAttachmentCount=%u",
3456 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003457 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003458 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003459 }
John Zulauff2582972019-02-09 14:53:30 -07003460 fb_attachment = color_attachment;
3461
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003462 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3463 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3464 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3465 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3466 "of a color attachment.",
3467 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003468 }
3469 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003470 bool subpass_depth = false;
3471 bool subpass_stencil = false;
3472 if (subpass_desc->pDepthStencilAttachment &&
3473 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3474 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3475 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3476 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3477 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003478 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003479 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3480 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003481 skip |= LogError(
3482 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3483 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003484 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003485 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003486 }
3487 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003488 skip |= LogError(
3489 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3490 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003491 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003492 attachment_index);
3493 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003494 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003495 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003496 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003497 if (subpass_depth) {
3498 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3499 "vkCmdClearAttachments()");
3500 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003501 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003502 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003503 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3504 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003505 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003506
3507 // Once the framebuffer attachment is found, can get the image view state
3508 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3509 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3510 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003511 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003512 if (image_view_state != nullptr) {
3513 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3514 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3515 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3516 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3517 }
3518 }
John Zulauf441558b2019-08-12 11:47:39 -06003519 }
3520 }
3521 return skip;
3522}
3523
3524void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3525 const VkClearAttachment *pAttachments, uint32_t rectCount,
3526 const VkClearRect *pRects) {
3527 auto *cb_node = GetCBState(commandBuffer);
3528 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003529 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3530 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003531 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3532 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3533 const auto clear_desc = &pAttachments[attachment_index];
3534 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3535 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3536 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3537 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3538 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3539 subpass_desc->pDepthStencilAttachment) {
3540 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3541 }
3542 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003543 if (!clear_rect_copy) {
3544 // We need a copy of the clear rectangles that will persist until the last lambda executes
3545 // but we want to create it as lazily as possible
3546 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003547 }
John Zulauf441558b2019-08-12 11:47:39 -06003548 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3549 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003550 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003551 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003552 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003553 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3554 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003555 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003556 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003557 return skip;
3558 };
3559 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003560 }
3561 }
3562 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003563}
3564
Jeff Leger178b1e52020-10-05 12:22:23 -04003565template <typename RegionType>
3566bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3567 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3568 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003569 const auto *cb_node = GetCBState(commandBuffer);
3570 const auto *src_image_state = GetImageState(srcImage);
3571 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003572 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3573 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3574 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3575 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003576
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003577 bool skip = false;
3578 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003579 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3580 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3581 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3582 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003583 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003584 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3585 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3586 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3587 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3588 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3589 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3590 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3591 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003592
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003593 // Validation for VK_EXT_fragment_density_map
3594 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003595 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003596 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003597 "%s: srcImage must not have been created with flags containing "
3598 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3599 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003600 }
3601 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003602 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003603 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003604 "%s: dstImage must not have been created with flags containing "
3605 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3606 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003607 }
3608
Cort Stratton7df30962018-05-17 19:45:57 -07003609 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003610 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3612 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003613 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003614 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3615 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3616 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003617 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003618 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3619 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3620 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3621 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3622 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3623 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003624 // For each region, the number of layers in the image subresource should not be zero
3625 // For each region, src and dest image aspect must be color only
3626 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003627 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003628 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3629 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003630 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3631 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3632 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003633 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3635 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003636 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003637 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3638 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3639 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3640 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3641 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3642 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003643 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003644 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3645 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003646 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003647 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003648
3649 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003650 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003651 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3652 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003653 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003654 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003655 }
Cort Stratton7df30962018-05-17 19:45:57 -07003656 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003657 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3658 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003659 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003660 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003661 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3662 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003663 }
3664
3665 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3666 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3667
3668 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003669 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003670 LogObjectList objlist(cb_node->commandBuffer());
3671 objlist.add(src_image_state->image());
3672 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003673 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3674 skip |= LogError(objlist, vuid,
3675 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003676 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003677 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003678 }
3679 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003680 LogObjectList objlist(cb_node->commandBuffer());
3681 objlist.add(src_image_state->image());
3682 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003683 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3684 skip |= LogError(objlist, vuid,
3685 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003686 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003687 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003688 }
3689 }
3690
3691 if (VK_IMAGE_TYPE_1D == src_image_type) {
3692 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003693 LogObjectList objlist(cb_node->commandBuffer());
3694 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003695 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3696 skip |= LogError(objlist, vuid,
3697 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003698 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003699 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003700 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003701 }
3702 }
3703 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3704 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003705 LogObjectList objlist(cb_node->commandBuffer());
3706 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003707 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3708 skip |= LogError(objlist, vuid,
3709 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003710 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003711 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003712 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003713 }
3714 }
3715
3716 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3717 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003718 LogObjectList objlist(cb_node->commandBuffer());
3719 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003720 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3721 skip |= LogError(objlist, vuid,
3722 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003723 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003724 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003725 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003726 }
3727 }
3728 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3729 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003730 LogObjectList objlist(cb_node->commandBuffer());
3731 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003732 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3733 skip |= LogError(objlist, vuid,
3734 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003735 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003736 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003737 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003738 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003739 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003740
3741 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003742 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003743 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3744 // developer
3745 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3746 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003747 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003748 LogObjectList objlist(cb_node->commandBuffer());
3749 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003750 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3751 skip |= LogError(objlist, vuid,
3752 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003753 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003754 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003755 region.extent.width, subresource_extent.width);
3756 }
3757
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003758 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003759 LogObjectList objlist(cb_node->commandBuffer());
3760 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003761 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3762 skip |= LogError(objlist, vuid,
3763 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003764 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003765 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003766 region.extent.height, subresource_extent.height);
3767 }
3768
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003769 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003770 LogObjectList objlist(cb_node->commandBuffer());
3771 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3773 skip |= LogError(objlist, vuid,
3774 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003775 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003776 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003777 region.extent.depth, subresource_extent.depth);
3778 }
3779 }
3780
3781 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003782 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003783 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3784 // developer
3785 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3786 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003787 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003788 LogObjectList objlist(cb_node->commandBuffer());
3789 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003790 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3791 skip |= LogError(objlist, vuid,
3792 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003793 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003794 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003795 region.extent.width, subresource_extent.width);
3796 }
3797
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003798 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003799 LogObjectList objlist(cb_node->commandBuffer());
3800 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003801 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3802 skip |= LogError(objlist, vuid,
3803 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003804 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003805 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003806 region.extent.height, subresource_extent.height);
3807 }
3808
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003809 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003810 LogObjectList objlist(cb_node->commandBuffer());
3811 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003812 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3813 skip |= LogError(objlist, vuid,
3814 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003815 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003816 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003817 region.extent.depth, subresource_extent.depth);
3818 }
3819 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003820 }
3821
3822 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003824 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 -04003825 func_name, string_VkFormat(src_image_state->createInfo.format),
3826 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003827 }
3828 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003829 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003830 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003831 string_VkImageType(src_image_state->createInfo.imageType),
3832 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003833 }
3834 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003835 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003836 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 -07003837 }
3838 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003839 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003840 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 -04003841 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003842 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003843 } else {
3844 assert(0);
3845 }
3846 return skip;
3847}
3848
Jeff Leger178b1e52020-10-05 12:22:23 -04003849bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3850 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3851 const VkImageResolve *pRegions) const {
3852 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3853 COPY_COMMAND_VERSION_1);
3854}
3855
3856bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3857 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3858 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3859 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3860 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3861}
3862
3863template <typename RegionType>
3864bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3865 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3866 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003867 const auto *cb_node = GetCBState(commandBuffer);
3868 const auto *src_image_state = GetImageState(srcImage);
3869 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003870
Jeff Leger178b1e52020-10-05 12:22:23 -04003871 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3872 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3873 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3874
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003875 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003876 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003877 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003878 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003879 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003880 const char *vuid;
3881 const char *location;
3882 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3883 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3884 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3885 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3886 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3887 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3888 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3889 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3890 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3891 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3892 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3893 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3894 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3895 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3896 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3897 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04003898 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003899 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3900 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3901 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3902 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3903 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3904 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3905 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3906 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3907 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3908 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003909
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003910 // Validation for VK_EXT_fragment_density_map
3911 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003913 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003914 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3915 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003916 }
3917 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003919 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003920 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3921 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003922 }
3923
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003924 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003925
Dave Houlton33c2d252017-06-09 17:08:32 -06003926 VkFormat src_format = src_image_state->createInfo.format;
3927 VkFormat dst_format = dst_image_state->createInfo.format;
3928 VkImageType src_type = src_image_state->createInfo.imageType;
3929 VkImageType dst_type = dst_image_state->createInfo.imageType;
3930
Cort Stratton186b1a22018-05-01 20:18:06 -04003931 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003932 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3933 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3934 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003935 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003936 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003937 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003938 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003939 }
3940
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003941 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3943 skip |= LogError(device, vuid,
3944 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003945 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003946 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003947 }
3948
3949 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003950 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3951 skip |= LogError(device, vuid,
3952 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003953 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003954 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003955 }
3956
Dave Houlton33c2d252017-06-09 17:08:32 -06003957 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003958 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003959 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003960 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003961 }
3962
Dave Houlton33c2d252017-06-09 17:08:32 -06003963 // Validate consistency for unsigned formats
3964 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3965 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003966 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003967 << "the other one must also have unsigned integer format. "
3968 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003969 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003970 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003971 }
3972
3973 // Validate consistency for signed formats
3974 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3975 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003976 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003977 << "the other one must also have signed integer format. "
3978 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003979 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003980 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003981 }
3982
3983 // Validate filter for Depth/Stencil formats
3984 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3985 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003986 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003987 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003988 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003989 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003990 }
3991
3992 // Validate aspect bits and formats for depth/stencil images
3993 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3994 if (src_format != dst_format) {
3995 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003996 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 -06003997 << "stencil, the other one must have exactly the same format. "
3998 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3999 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004000 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004001 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004002 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004003 } // Depth or Stencil
4004
4005 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004006 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004007 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4008 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4009 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
4010 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4011 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4012 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004013 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04004014 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4015 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4016 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
4017 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4018 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4019 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004020 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004021 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004022 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004023 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004024 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004025 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4026 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004027 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004028 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4029 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4030 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4031 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4032 skip |=
4033 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4034 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4035 skip |=
4036 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004038 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004039 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4040 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004041 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004042 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004043 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004044 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4045 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004046 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004047 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004048 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004049 }
Dave Houlton48989f32017-05-26 15:01:46 -06004050 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4051 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004052 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004054 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004055 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004056
4057 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004058 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004059 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4060 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004061 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004062 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004063 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004064
Dave Houlton48989f32017-05-26 15:01:46 -06004065 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004066 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4067 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004068 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004069 }
Dave Houlton48989f32017-05-26 15:01:46 -06004070
Dave Houlton33c2d252017-06-09 17:08:32 -06004071 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004072 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004073 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004074 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004075 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004076 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004077 }
4078
4079 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004080 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004081 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004082 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4083 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004084 }
4085
Dave Houlton48989f32017-05-26 15:01:46 -06004086 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004087 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004088 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004089 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004090 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004091 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004092 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4093 "of (%1d, %1d). These must be (0, 1).",
4094 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004095 }
4096 }
4097
Dave Houlton33c2d252017-06-09 17:08:32 -06004098 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004099 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004100 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004101 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004102 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4103 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4104 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004105 }
4106 }
4107
Dave Houlton33c2d252017-06-09 17:08:32 -06004108 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004109 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4110 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004111 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004112 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004113 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004114 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4115 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004116 }
4117 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4118 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004119 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004120 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004121 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004122 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4123 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004124 }
4125 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4126 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004127 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004128 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004129 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004130 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4131 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004132 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004133 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004134 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004135 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004136 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004137 }
Dave Houlton48989f32017-05-26 15:01:46 -06004138
4139 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004140 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004141 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004142 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004143 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004144 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004145 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4146 "(%1d, %1d). These must be (0, 1).",
4147 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004148 }
4149 }
4150
Dave Houlton33c2d252017-06-09 17:08:32 -06004151 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004152 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004153 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004154 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004155 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004156 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004157 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004158 }
4159 }
4160
Dave Houlton33c2d252017-06-09 17:08:32 -06004161 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004162 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4163 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004164 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004165 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004166 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004167 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4168 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004169 }
4170 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4171 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004172 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004173 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004174 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004175 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4176 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004177 }
4178 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4179 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004180 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004181 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004182 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004183 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4184 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004185 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004186 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004187 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004188 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004189 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004190 }
4191
Dave Houlton33c2d252017-06-09 17:08:32 -06004192 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4193 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4194 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004195 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004196 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004197 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4198 "layerCount other than 1.",
4199 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004200 }
4201 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004202 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004203 } else {
4204 assert(0);
4205 }
4206 return skip;
4207}
4208
Jeff Leger178b1e52020-10-05 12:22:23 -04004209bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4210 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4211 const VkImageBlit *pRegions, VkFilter filter) const {
4212 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4213 COPY_COMMAND_VERSION_1);
4214}
4215
4216bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4217 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4218 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4219 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4220}
4221
4222template <typename RegionType>
4223void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4224 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4225 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004226 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004227 auto src_image_state = GetImageState(srcImage);
4228 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004229
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004230 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004231 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004232 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4233 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004234 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004235}
4236
Jeff Leger178b1e52020-10-05 12:22:23 -04004237void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4238 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4239 const VkImageBlit *pRegions, VkFilter filter) {
4240 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4241 pRegions, filter);
4242 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4243}
4244
4245void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4246 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4247 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4248 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4249 pBlitImageInfo->filter);
4250}
4251
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004252GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004253 // This approach allows for a single hash lookup or/create new
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004254 auto &layout_map = map[image_state.image()];
John Zulauf17708d02021-02-22 11:20:58 -07004255 if (!layout_map) {
4256 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004257 }
John Zulauf17708d02021-02-22 11:20:58 -07004258 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004259}
4260
4261const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4262 auto it = map.find(image);
4263 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004264 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004265 }
4266 return nullptr;
4267}
4268
Jeremy Gebben53631302021-04-13 16:46:37 -06004269// Helper to update the Global or Overlay layout map
4270struct GlobalLayoutUpdater {
4271 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4272 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4273 dst = src.current_layout;
4274 return true;
4275 }
4276 return false;
4277 }
4278
4279 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4280 layer_data::optional<VkImageLayout> result;
4281 if (src.current_layout != image_layout_map::kInvalidLayout) {
4282 result.emplace(src.current_layout);
4283 }
4284 return result;
4285 }
4286};
4287
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004288// 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 -07004289bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004290 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004291 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004292 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004293 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004294 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004295 for (const auto &layout_map_entry : pCB->image_layout_map) {
4296 const auto image = layout_map_entry.first;
4297 const auto *image_state = GetImageState(image);
4298 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004299 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004300 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004301 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004302 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004303
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004304 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004305 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4306 if (global_map == nullptr) {
4307 global_map = &empty_map;
4308 }
4309
4310 // Note: don't know if it would matter
4311 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4312
Jeremy Gebben53631302021-04-13 16:46:37 -06004313 auto pos = layout_map.begin();
4314 const auto end = layout_map.end();
4315 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4316 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004317 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004318 VkImageLayout initial_layout = pos->second.initial_layout;
4319 assert(initial_layout != image_layout_map::kInvalidLayout);
4320 if (initial_layout == image_layout_map::kInvalidLayout) {
4321 continue;
4322 }
4323
John Zulauf2076e812020-01-08 14:55:54 -07004324 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004325
John Zulauf2076e812020-01-08 14:55:54 -07004326 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 -07004327 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004328 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004329 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004330 image_layout = current_layout->pos_B->lower_bound->second;
4331 }
4332 const auto intersected_range = pos->first & current_layout->range;
4333 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4334 // TODO: Set memory invalid which is in mem_tracker currently
4335 } else if (image_layout != initial_layout) {
4336 // Need to look up the inital layout *state* to get a bit more information
4337 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4338 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4339 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4340 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004341 // We can report all the errors for the intersected range directly
4342 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004343 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004344 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004345 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004346 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004347 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004348 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004349 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004350 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004351 }
4352 }
John Zulauf2076e812020-01-08 14:55:54 -07004353 if (pos->first.includes(intersected_range.end)) {
4354 current_layout.seek(intersected_range.end);
4355 } else {
4356 ++pos;
4357 if (pos != end) {
4358 current_layout.seek(pos->first.begin);
4359 }
4360 }
John Zulauff660ad62019-03-23 07:16:05 -06004361 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004362 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004363 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004364 }
John Zulauff660ad62019-03-23 07:16:05 -06004365
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004366 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004367}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004368
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004369void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004370 for (const auto &layout_map_entry : pCB->image_layout_map) {
4371 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004372 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004373 const auto *image_state = GetImageState(image);
4374 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004375 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004376 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004377 }
4378}
4379
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004380// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004381// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4382// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004383bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4384 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004385 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004386 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004387 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4388
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004389 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004390 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4391 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004392 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004393 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4394 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4395 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004396 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004397 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004398 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004399 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4400 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4401 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004402 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004403 string_VkImageLayout(first_layout));
4404 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4405 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004406 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004407 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004409 }
4410 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004411
4412 // Same as above for loadOp, but for stencilLoadOp
4413 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4414 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4415 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4416 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4417 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004418 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004419 string_VkImageLayout(first_layout));
4420 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4421 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4422 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004423 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004424 string_VkImageLayout(first_layout));
4425 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4426 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4427 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004428 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004429 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004430 }
4431 }
4432
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004433 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004434}
4435
Mark Lobodzinski96210742017-02-09 10:33:46 -07004436// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4437// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004438template <typename T1>
4439bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4440 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4441 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004442 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004443 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004444 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004445 if (strict) {
4446 correct_usage = ((actual & desired) == desired);
4447 } else {
4448 correct_usage = ((actual & desired) != 0);
4449 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004450
Mark Lobodzinski96210742017-02-09 10:33:46 -07004451 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004452 // All callers should have a valid VUID
4453 assert(msgCode != kVUIDUndefined);
4454 skip =
4455 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4456 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004457 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004458 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004459}
4460
4461// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4462// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004463bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004464 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004465 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004466 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004467}
4468
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004469bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004470 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004471 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004472 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4473 if ((image_format_features & desired) != desired) {
4474 // Same error, but more details if it was an AHB external format
4475 if (image_state->has_ahb_format == true) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004476 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004477 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4478 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4479 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004480 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004481 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004482 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004483 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4484 "with tiling %s.",
4485 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004486 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004487 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004488 }
4489 }
4490 return skip;
4491}
4492
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004493bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004494 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004495 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004496 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004497 // layerCount must not be zero
4498 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004499 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004500 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004501 }
4502 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004503 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004504 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004505 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004506 }
4507 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004508 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 -06004509 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004510 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4511 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4512 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004513 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004514 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4515 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4516 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004517 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004518 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4519 member);
4520 }
Cort Strattond619a302018-05-17 19:46:32 -07004521 return skip;
4522}
4523
Mark Lobodzinski96210742017-02-09 10:33:46 -07004524// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4525// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004526bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004527 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004528 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004529 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004530}
4531
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004532bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004533 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004534 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004535
4536 const VkDeviceSize &range = pCreateInfo->range;
4537 if (range != VK_WHOLE_SIZE) {
4538 // Range must be greater than 0
4539 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004540 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004541 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004542 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4543 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004544 }
4545 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004546 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4547 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004548 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004549 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004550 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4551 "(%" PRIu32 ").",
4552 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004553 }
4554 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004555 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004556 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004557 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004558 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4559 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4560 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004561 }
4562 // The sum of range and offset must be less than or equal to the size of buffer
4563 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004564 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004565 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004566 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4567 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4568 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004569 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004570 } else {
4571 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4572
4573 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4574 // VkPhysicalDeviceLimits::maxTexelBufferElements
4575 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4576 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004577 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004578 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4579 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4580 "), divided by the element size of the format (%" PRIu32
4581 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4582 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4583 device_limits->maxTexelBufferElements);
4584 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004585 }
4586 return skip;
4587}
4588
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004589bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004590 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004591 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004592 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4593 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004594 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004595 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004596 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4597 "be supported for uniform texel buffers",
4598 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004599 }
4600 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4601 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004602 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004603 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004604 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4605 "be supported for storage texel buffers",
4606 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004607 }
4608 return skip;
4609}
4610
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004611bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004612 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004613 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004614
Dave Houltond8ed0212018-05-16 17:18:24 -06004615 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004616
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004617 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004618 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004619 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004620 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004621 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4622 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004623 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004624 }
4625 }
4626
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004627 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004628 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004629 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004630 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004632 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4633 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004634 }
4635 }
4636
Mike Schuchardt2df08912020-12-15 16:28:09 -08004637 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004638 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4639 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004640 skip |= LogError(
4641 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004642 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004643 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004644 }
4645
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004646 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004647 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4648 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4649 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004650 }
4651
sfricke-samsungedce77a2020-07-03 22:35:13 -07004652 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4653 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4654 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4655 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4656 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4657 }
4658 const VkBufferCreateFlags invalid_flags =
4659 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4660 if ((pCreateInfo->flags & invalid_flags) != 0) {
4661 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4662 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4663 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4664 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4665 }
4666 }
4667
Mark Lobodzinski96210742017-02-09 10:33:46 -07004668 return skip;
4669}
4670
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004671bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004672 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004673 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004674 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004675 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4676 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004677 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004678 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4679 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004680 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004681 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4682 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4683 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004684
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004685 // Buffer view offset must be less than the size of buffer
4686 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004687 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004688 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004689 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4690 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004691 }
4692
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004693 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004694 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4695 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4696 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004697 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4698 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004699 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004700 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004701 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4702 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004703 }
4704
4705 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004706 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4707 if ((element_size % 3) == 0) {
4708 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004709 }
4710 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004711 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004712 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4713 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004714 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004715 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004716 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004717 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004718 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004719 "vkCreateBufferView(): If buffer was created with usage containing "
4720 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004721 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4722 ") must be a multiple of the lesser of "
4723 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4724 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4725 "(%" PRId32
4726 ") is VK_TRUE, the size of a texel of the requested format. "
4727 "If the size of a texel is a multiple of three bytes, then the size of a "
4728 "single component of format is used instead",
4729 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4730 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4731 }
4732 }
4733 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004734 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004735 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4736 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004737 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004738 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004739 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004740 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004741 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004742 "vkCreateBufferView(): If buffer was created with usage containing "
4743 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004744 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4745 ") must be a multiple of the lesser of "
4746 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4747 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4748 "(%" PRId32
4749 ") is VK_TRUE, the size of a texel of the requested format. "
4750 "If the size of a texel is a multiple of three bytes, then the size of a "
4751 "single component of format is used instead",
4752 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4753 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4754 }
4755 }
4756 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004757
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004758 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004759
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004760 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004761 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004762 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004763}
4764
Mark Lobodzinski602de982017-02-09 11:01:33 -07004765// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004766bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004767 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004768 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004769 const IMAGE_STATE *image_state = GetImageState(image);
4770 // checks color format and (single-plane or non-disjoint)
4771 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004772 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004773 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004774 skip |= LogError(
4775 image, vuid,
4776 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4777 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004778 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004779 skip |= LogError(image, vuid,
4780 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4781 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4782 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004783 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004784 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004785 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004786 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004787 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4788 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4789 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004790 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004791 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004792 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4793 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4794 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004795 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004796 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004797 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004798 skip |= LogError(image, vuid,
4799 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4800 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4801 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004802 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004803 skip |= LogError(image, vuid,
4804 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4805 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4806 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004807 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004808 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004809 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004810 skip |= LogError(image, vuid,
4811 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4812 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4813 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004814 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004815 skip |= LogError(image, vuid,
4816 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4817 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4818 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004819 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004820 } else if (FormatIsMultiplane(format)) {
4821 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4822 if (3 == FormatPlaneCount(format)) {
4823 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4824 }
4825 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004826 skip |= LogError(image, vuid,
4827 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4828 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4829 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004830 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004831 }
4832 return skip;
4833}
4834
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004835bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4836 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004837 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004838 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004839 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004840
4841 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004842 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004843 skip |= LogError(image, errorCodes.base_mip_err,
4844 "%s: %s.baseMipLevel (= %" PRIu32
4845 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4846 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004847 }
Petr Kraus4d718682017-05-18 03:38:41 +02004848
Petr Krausffa94af2017-08-08 21:46:02 +02004849 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4850 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004851 skip |=
4852 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004853 } else {
4854 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004855
Petr Krausffa94af2017-08-08 21:46:02 +02004856 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004857 skip |= LogError(image, errorCodes.mip_count_err,
4858 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4859 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4860 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4861 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004862 }
Petr Kraus4d718682017-05-18 03:38:41 +02004863 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004864 }
Petr Kraus4d718682017-05-18 03:38:41 +02004865
4866 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004867 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004868 skip |= LogError(image, errorCodes.base_layer_err,
4869 "%s: %s.baseArrayLayer (= %" PRIu32
4870 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4871 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004872 }
Petr Kraus4d718682017-05-18 03:38:41 +02004873
Petr Krausffa94af2017-08-08 21:46:02 +02004874 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4875 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004876 skip |=
4877 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004878 } else {
4879 const uint64_t necessary_layer_count =
4880 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004881
Petr Krausffa94af2017-08-08 21:46:02 +02004882 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004883 skip |= LogError(image, errorCodes.layer_count_err,
4884 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4885 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4886 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4887 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004888 }
Petr Kraus4d718682017-05-18 03:38:41 +02004889 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004890 }
Petr Kraus4d718682017-05-18 03:38:41 +02004891
Mark Lobodzinski602de982017-02-09 11:01:33 -07004892 return skip;
4893}
4894
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004895bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004896 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004897 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004898 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004899 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004900 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 +02004901
David McFarland2853f2f2020-11-30 15:50:39 -04004902 uint32_t image_layer_count;
4903
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004904 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004905 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004906 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004907 image_layer_count = extent.depth;
4908 } else {
4909 image_layer_count = image_state->createInfo.arrayLayers;
4910 }
4911
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004912 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004913
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004914 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4915 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4916 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4917 subresource_range_error_codes.base_layer_err =
4918 is_khr_maintenance1
4919 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4920 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4921 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4922 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4923 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4924 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004925
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004926 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004927 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004928 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004929}
4930
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004931bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004932 const VkImageSubresourceRange &subresourceRange,
4933 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004934 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4935 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4936 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4937 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4938 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004939
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004940 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004941 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004942 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004943}
4944
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004945bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004946 const VkImageSubresourceRange &subresourceRange,
4947 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004948 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4949 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4950 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4951 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4952 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004953
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004954 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004955 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004956 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004957}
4958
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07004959bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004960 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004961 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004962 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07004963 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02004964}
4965
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004966namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004967using sync_vuid_maps::GetBarrierQueueVUID;
4968using sync_vuid_maps::kQueueErrorSummary;
4969using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004970
4971class ValidatorState {
4972 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07004973 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004974 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
4975 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07004976 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004977 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004978 barrier_handle_(barrier_handle),
4979 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004980 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
4981 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
4982
4983 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
4984 // 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 -07004985 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
4986 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004987 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004988 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
4989 loc_.Message().c_str(), GetTypeString(),
4990 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
4991 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004992 }
4993
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004994 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
4995 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004996 const char *src_annotation = GetFamilyAnnotation(src_family);
4997 const char *dst_annotation = GetFamilyAnnotation(dst_family);
4998 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004999 objects_, val_code,
5000 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5001 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5002 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005003 }
5004
5005 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5006 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5007 // application input.
5008 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5009 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005010 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005011 uint32_t queue_family = queue_state->queueFamilyIndex;
5012 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005013 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005014 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5015 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5016 return device_data->LogError(
5017 queue_state->queue, val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005018 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005019 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005020 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005021 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005022 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005023 }
5024 return false;
5025 }
5026 // Logical helpers for semantic clarity
5027 inline bool KhrExternalMem() const { return mem_ext_; }
5028 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5029 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5030 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5031 }
5032
5033 // Helpers for LogMsg
5034 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5035
5036 // Descriptive text for the various types of queue family index
5037 const char *GetFamilyAnnotation(uint32_t family) const {
5038 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5039 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5040 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5041 const char *valid = " (VALID)";
5042 const char *invalid = " (INVALID)";
5043 switch (family) {
5044 case VK_QUEUE_FAMILY_EXTERNAL:
5045 return external;
5046 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5047 return foreign;
5048 case VK_QUEUE_FAMILY_IGNORED:
5049 return ignored;
5050 default:
5051 if (IsValid(family)) {
5052 return valid;
5053 }
5054 return invalid;
5055 };
5056 }
5057 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5058 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5059
5060 protected:
5061 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005062 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005063 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005064 const VulkanTypedHandle barrier_handle_;
5065 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005066 const uint32_t limit_;
5067 const bool mem_ext_;
5068};
5069
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005070bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005071 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5072 bool skip = false;
5073
5074 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5075 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5076 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5077 if (val.KhrExternalMem()) {
5078 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005079 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5080 // this requirement is removed by VK_KHR_synchronization2
5081 if (!(src_ignored || dst_ignored) && !sync2) {
5082 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005083 }
5084 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5085 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005086 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005087 }
5088 } else {
5089 // VK_SHARING_MODE_EXCLUSIVE
5090 if (src_queue_family != dst_queue_family) {
5091 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005092 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005093 }
5094 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005095 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005096 }
5097 }
5098 }
5099 } else {
5100 // No memory extension
5101 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005102 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5103 // this requirement is removed by VK_KHR_synchronization2
5104 if ((!src_ignored || !dst_ignored) && !sync2) {
5105 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005106 }
5107 } else {
5108 // VK_SHARING_MODE_EXCLUSIVE
5109 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005110 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005111 }
5112 }
5113 }
5114 return skip;
5115}
5116} // namespace barrier_queue_families
5117
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005118bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005119 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005120 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5121 uint32_t dst_queue_family) {
5122 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005123 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005124 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5125}
5126
5127// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005128template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005129bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5130 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005131 // State data is required
5132 if (!state_data) {
5133 return false;
5134 }
5135
5136 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005137 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005138 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005139 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5140 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005141 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005142}
5143
5144// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005145template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005146bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5147 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005148 // State data is required
5149 if (!state_data) {
5150 return false;
5151 }
5152
5153 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005154 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005155 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005156 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5157 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005158 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5159}
5160
5161template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005162bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005163 const Barrier &mem_barrier) const {
5164 using sync_vuid_maps::BufferError;
5165 using sync_vuid_maps::GetBufferBarrierVUID;
5166
5167 bool skip = false;
5168
5169 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5170
5171 // Validate buffer barrier queue family indices
5172 auto buffer_state = GetBufferState(mem_barrier.buffer);
5173 if (buffer_state) {
5174 auto buf_loc = loc.dot(Field::buffer);
5175 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005176 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005177
5178 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5179
5180 auto buffer_size = buffer_state->createInfo.size;
5181 if (mem_barrier.offset >= buffer_size) {
5182 auto offset_loc = loc.dot(Field::offset);
5183 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5184
5185 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5186 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5187 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5188 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5189 auto size_loc = loc.dot(Field::size);
5190 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5191 skip |= LogError(objects, vuid,
5192 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5193 ".",
5194 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5195 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5196 }
5197 if (mem_barrier.size == 0) {
5198 auto size_loc = loc.dot(Field::size);
5199 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5200 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5201 report_data->FormatHandle(mem_barrier.buffer).c_str());
5202 }
5203 }
5204 return skip;
5205}
5206
5207template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005208bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005209 const Barrier &mem_barrier) const {
5210 bool skip = false;
5211
5212 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5213
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005214 bool is_ilt = true;
5215 if (enabled_features.synchronization2_features.synchronization2) {
5216 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5217 }
5218
5219 if (is_ilt) {
5220 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5221 auto layout_loc = loc.dot(Field::newLayout);
5222 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5223 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005224 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005225 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005226 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005227 }
5228
5229 auto image_data = GetImageState(mem_barrier.image);
5230 if (image_data) {
5231 auto image_loc = loc.dot(Field::image);
5232
John Zulaufbea70432021-02-23 07:03:12 -07005233 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005234
5235 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5236
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005237 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005238 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005239
5240 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5241 }
5242 return skip;
5243}
5244
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005245bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5246 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5247 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005248 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5249 const VkImageMemoryBarrier *pImageMemBarriers) const {
5250 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005251 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005252
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005253 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5254 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005255 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005256 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005257 }
5258 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5259 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005260 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005261 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005262 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5263 }
5264 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005265 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005266 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5267 }
5268 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5269 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005270 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005271 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005272 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5273 }
5274 return skip;
5275}
5276
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005277bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005278 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005279 bool skip = false;
5280
5281 if (cb_state->activeRenderPass) {
5282 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5283 if (skip) return true; // Early return to avoid redundant errors from below calls
5284 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005285 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5286 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005287 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005288 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005289 }
5290 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5291 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005292 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005293 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005294 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5295 }
5296 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005297 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005298 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5299 }
5300
5301 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5302 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005303 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005304 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005305 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5306 }
5307
5308 return skip;
5309}
5310
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005311// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005312template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005313bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5314 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005315 VkPipelineStageFlags dst_stage_mask) const {
5316 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005317 assert(cb_state);
5318 auto queue_flags = cb_state->GetQueueFlags();
5319
5320 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005321 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5322 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005323 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005324 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5325 }
5326 return skip;
5327}
5328
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005329// template to check all synchronization2 barrier structures and VkSubpassDependency2
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005330template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005331bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5332 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005333 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005334 // NOTE: cb_state will only be null when checking subpass dependencies, which happens in vkCreateRenderPass(), where
5335 // a command buffer is not yet available.
5336 auto queue_flags = cb_state ? cb_state->GetQueueFlags() : sync_utils::kAllQueueTypes;
5337
Jeremy Gebbenefead332021-06-18 08:22:44 -06005338 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005339 if (!cb_state || !cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005340 skip |=
5341 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5342 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005343
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005344 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
5345 if (!cb_state || !cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005346 skip |=
5347 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5348 }
5349 return skip;
5350}
5351
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005352bool CoreChecks::ValidateSubpassBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005353 const VkSubpassDependency2 &barrier) const {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005354 bool skip = false;
5355 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(barrier.pNext);
5356 if (mem_barrier) {
5357 if (enabled_features.synchronization2_features.synchronization2) {
5358 if (barrier.srcAccessMask != 0) {
5359 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5360 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5361 loc.dot(Field::srcAccessMask).Message().c_str());
5362 }
5363 if (barrier.dstAccessMask != 0) {
5364 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5365 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5366 loc.dot(Field::dstAccessMask).Message().c_str());
5367 }
5368 if (barrier.srcStageMask != 0 || barrier.dstStageMask != 0) {
5369 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5370 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5371 loc.dot(Field::srcStageMask).Message().c_str());
5372 }
5373 if (barrier.dstStageMask != 0) {
5374 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5375 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5376 loc.dot(Field::dstStageMask).Message().c_str());
5377 }
5378
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005379 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc.dot(Field::pNext), cb_state, *mem_barrier);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005380 return skip;
5381 } else {
5382 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5383 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5384 loc.Message().c_str());
5385 }
5386 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005387 skip |= CoreChecks::ValidateMemoryBarrier(objects, loc, cb_state, barrier);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005388 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005389}
5390
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005391bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5392 const VkImageUsageFlags image_usage) const {
5393 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5394 bool skip = false;
5395
5396 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5397 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5398
5399 if (image_state->has_ahb_format == true) {
5400 // AHB image view and image share same feature sets
5401 tiling_features = image_state->format_features;
5402 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5403 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
5404 assert(device_extensions.vk_ext_image_drm_format_modifier);
5405 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5406 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005407 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005408
5409 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5410 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5411 nullptr};
5412 format_properties_2.pNext = (void *)&drm_properties_list;
5413 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5414
nyorain38a9d232021-03-06 13:06:12 +01005415 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5416 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5417 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5418
5419 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5420
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005421 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5422 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5423 0) {
5424 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5425 }
5426 }
5427 } else {
5428 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5429 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5430 : format_properties.optimalTilingFeatures;
5431 }
5432
5433 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005434 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005435 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5436 "physical device.",
5437 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5438 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005439 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005440 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5441 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5442 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5443 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005444 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005445 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5446 "VK_IMAGE_USAGE_STORAGE_BIT.",
5447 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5448 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005449 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005450 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5451 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5452 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5453 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5454 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005455 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005456 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5457 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5458 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5459 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5460 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005461 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005462 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5463 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5464 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005465 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5466 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5467 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005468 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005469 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5470 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5471 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5472 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005473 }
5474
5475 return skip;
5476}
5477
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005478bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005479 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005480 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005481 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005482 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005483 skip |=
5484 ValidateImageUsageFlags(image_state,
5485 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5486 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005487 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5488 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5489 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005490 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005491 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005492 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005493 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005494 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005495 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005496 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005497 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005498
5499 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5500 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005501 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005502 VkFormat view_format = pCreateInfo->format;
5503 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005504 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005505 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005506
Dave Houltonbd2e2622018-04-10 16:41:14 -06005507 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005508 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005509 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005510 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005511 if (!device_extensions.vk_ext_separate_stencil_usage) {
5512 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005513 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5514 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5515 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005516 }
5517 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005518 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005519 if (image_stencil_struct == nullptr) {
5520 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005521 skip |= LogError(
5522 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005523 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5524 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5525 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5526 }
5527 } else {
5528 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5529 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5530 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005531 skip |= LogError(
5532 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005533 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5534 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5535 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5536 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5537 }
5538 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5539 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005540 skip |= LogError(
5541 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005542 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5543 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5544 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5545 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5546 }
5547 }
5548 }
5549 }
5550
Dave Houltonbd2e2622018-04-10 16:41:14 -06005551 image_usage = chained_ivuci_struct->usage;
5552 }
5553
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005554 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5555 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5556 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5557 bool foundFormat = false;
5558 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5559 if (format_list_info->pViewFormats[i] == view_format) {
5560 foundFormat = true;
5561 break;
5562 }
5563 }
5564 if (foundFormat == false) {
5565 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5566 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5567 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5568 string_VkFormat(view_format));
5569 }
5570 }
5571
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005572 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5573 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005574 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005575 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005576 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005577 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005578 std::stringstream ss;
5579 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005580 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005581 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005582 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005583 }
5584 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005585 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005586 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
sfricke-samsung9a65d282021-03-17 23:41:59 -07005587 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5588 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5589 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5590 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005591 const char *error_vuid;
5592 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5593 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5594 } else if ((device_extensions.vk_khr_maintenance2) &&
5595 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5596 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5597 } else if ((!device_extensions.vk_khr_maintenance2) &&
5598 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5599 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5600 } else {
5601 // both enabled
5602 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5603 }
Dave Houltonc7988072018-04-16 11:46:56 -06005604 std::stringstream ss;
5605 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005606 << " is not in the same format compatibility class as "
5607 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005608 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5609 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005610 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005611 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005612 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005613 }
5614 } else {
5615 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005616 // Unless it is a multi-planar color bit aspect
5617 if ((image_format != view_format) &&
5618 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5619 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5620 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005621 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005622 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005623 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005624 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005625 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005626 }
5627 }
5628
5629 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005630 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005631
5632 switch (image_type) {
5633 case VK_IMAGE_TYPE_1D:
5634 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005635 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5636 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5637 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005638 }
5639 break;
5640 case VK_IMAGE_TYPE_2D:
5641 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5642 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5643 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005644 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5645 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5646 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005647 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005648 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5649 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5650 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005651 }
5652 }
5653 break;
5654 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005655 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005656 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5657 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005658 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005659 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005660 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5661 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5662 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005663 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5664 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005665 skip |= LogError(
5666 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5667 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5668 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5669 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5670 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005671 }
5672 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005673 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5674 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5675 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005676 }
5677 }
5678 } else {
5679 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005680 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5681 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5682 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005683 }
5684 }
5685 break;
5686 default:
5687 break;
5688 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005689
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005690 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005691 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005692 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005693 }
5694
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005695 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005696
Tobias Hector6663c9b2020-11-05 10:18:02 +00005697 if (enabled_features.shading_rate_image.shadingRateImage) {
5698 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5699 if (view_format != VK_FORMAT_R8_UINT) {
5700 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5701 "vkCreateImageView() If image was created with usage containing "
5702 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5703 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005704 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005705 }
5706
5707 if (enabled_features.shading_rate_image.shadingRateImage ||
5708 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5709 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5710 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5711 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5712 "vkCreateImageView() If image was created with usage containing "
5713 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5714 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5715 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005716 }
5717 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005718
Tobias Hector6663c9b2020-11-05 10:18:02 +00005719 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5720 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
5721 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR &&
5722 pCreateInfo->subresourceRange.layerCount != 1) {
5723 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5724 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
5725 pCreateInfo->subresourceRange.layerCount);
5726 }
5727
Jeff Bolz99e3f632020-03-24 22:59:22 -05005728 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5729 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5730 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5731 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5732 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5733 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5734 }
5735 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5736 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5737 skip |= LogError(
5738 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5739 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5740 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5741 }
5742 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005743
5744 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5745 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005746 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005747 "vkCreateImageView(): If image was created with usage containing "
5748 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5749 pCreateInfo->subresourceRange.levelCount);
5750 }
5751 }
5752 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5753 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005754 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005755 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5756 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5757 }
5758 } else {
5759 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5760 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5761 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005762 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005763 "vkCreateImageView(): If image was created with usage containing "
5764 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5765 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5766 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5767 }
5768 }
5769 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005770
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005771 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5772 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5773 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5774 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5775 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5776 }
5777 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5778 skip |=
5779 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5780 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5781 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5782 }
5783 }
5784 if (device_extensions.vk_ext_fragment_density_map_2) {
5785 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5786 (pCreateInfo->subresourceRange.layerCount >
5787 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5788 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5789 "vkCreateImageView(): If image was created with flags containing "
5790 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5791 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5792 pCreateInfo->subresourceRange.layerCount,
5793 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5794 }
5795 }
5796
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005797 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005798 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5799 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5800 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5801 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5802 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5803 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5804 }
5805 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005806
5807 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
5808 // If swizzling is disabled, make sure it isn't used
5809 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
5810 (pCreateInfo->components.r != VK_COMPONENT_SWIZZLE_IDENTITY ||
5811 pCreateInfo->components.g != VK_COMPONENT_SWIZZLE_IDENTITY ||
5812 pCreateInfo->components.b != VK_COMPONENT_SWIZZLE_IDENTITY ||
5813 pCreateInfo->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
5814 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5815 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5816 }
5817
5818 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5819 // disabled
5820 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5821 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5822 // spec. See Github issue #2361.
5823 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5824 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5825 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
5826 (FormatChannelCount(pCreateInfo->format) != FormatChannelCount(image_state->createInfo.format)))) {
5827 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5828 "vkCreateImageView (portability error): ImageView format must have"
5829 " the same number of components and bits per component as the Image's format");
5830 }
5831 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005832 }
5833 return skip;
5834}
5835
Jeff Leger178b1e52020-10-05 12:22:23 -04005836template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005837bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005838 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005839 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005840 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5841 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5842 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005843
5844 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5845 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5846 VkDeviceSize src_min = UINT64_MAX;
5847 VkDeviceSize src_max = 0;
5848 VkDeviceSize dst_min = UINT64_MAX;
5849 VkDeviceSize dst_max = 0;
5850
5851 for (uint32_t i = 0; i < regionCount; i++) {
5852 src_min = std::min(src_min, pRegions[i].srcOffset);
5853 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5854 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5855 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5856
5857 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5858 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005859 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005860 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005861 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5862 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005863 }
5864
5865 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5866 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005867 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005868 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005869 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5870 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005871 }
5872
5873 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5874 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005875 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005876 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005877 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005878 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005879 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005880 }
5881
5882 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5883 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005884 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005885 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005886 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005887 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005888 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005889 }
5890 }
5891
5892 // The union of the source regions, and the union of the destination regions, must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005893 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005894 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005895 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005896 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04005897 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005898 }
5899 }
5900
5901 return skip;
5902}
5903
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005904bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005905 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005906 const auto cb_node = GetCBState(commandBuffer);
5907 const auto src_buffer_state = GetBufferState(srcBuffer);
5908 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005909
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005910 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005911 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5912 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005913 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005914 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005915 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5916 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005917 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005918 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5919 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005920 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Jeff Leger178b1e52020-10-05 12:22:23 -04005921 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005922 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5923 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5924 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005925 return skip;
5926}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005927
Jeff Leger178b1e52020-10-05 12:22:23 -04005928bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5929 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5930 const auto cb_node = GetCBState(commandBuffer);
5931 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5932 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5933
5934 bool skip = false;
5935 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5936 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5937 // Validate that SRC & DST buffers have correct usage flags set
5938 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5939 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5940 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5941 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5942 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5943 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005944 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
Jeff Leger178b1e52020-10-05 12:22:23 -04005945 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5946 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5947 skip |=
5948 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5949 skip |=
5950 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5951 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5952 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5953 return skip;
5954}
5955
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005956bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005957 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005958 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005959 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005960 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005961 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5962 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005963 }
5964 }
5965 return skip;
5966}
5967
Jeff Bolz5c801d12019-10-09 10:38:45 -05005968bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5969 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005970 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005971
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005972 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005973 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005974 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005975 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005976 }
5977 return skip;
5978}
5979
Jeff Bolz5c801d12019-10-09 10:38:45 -05005980bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005981 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005982
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005983 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005984 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005985 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005986 }
5987 return skip;
5988}
5989
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06005990void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
5991 const auto buffer_state = Get<BUFFER_STATE>(buffer);
5992 if (buffer_state) {
5993 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
5994 if (itr != buffer_address_map_.end()) {
5995 buffer_address_map_.erase(itr);
5996 }
5997 }
5998 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
5999}
6000
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006001bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006002 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006003 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006004 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006005 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006006 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006007 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006008 }
6009 return skip;
6010}
6011
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006012bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006013 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006014 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006015 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006016 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006017 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006018 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006019 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006020 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6021 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006022
sfricke-samsung022fa252020-07-24 03:26:16 -07006023 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6024 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6025
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006026 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006027 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6028 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6029 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6030 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006031 }
6032
6033 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006034 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6035 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6036 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6037 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006038 }
6039
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006040 return skip;
6041}
6042
Jeff Leger178b1e52020-10-05 12:22:23 -04006043template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006044bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006045 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006046 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006047 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006048 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6049 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006050
sfricke-samsung125d2b42020-05-28 06:32:43 -07006051 assert(image_state != nullptr);
6052 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006053
6054 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006055 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006056 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6057 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006058 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006059 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6060 "and 1, respectively.",
6061 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006062 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006063 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006064
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006065 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6066 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006067 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006068 "%s: pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006069 "must be 0 and 1, respectively.",
6070 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006071 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006072 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006073
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006074 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6075 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006076 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006077 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006078 "For 3D images these must be 0 and 1, respectively.",
6079 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006080 }
6081 }
6082
6083 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006084 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung8feecc12021-01-23 03:28:38 -08006085 const uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
6086 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006087
sfricke-samsung8feecc12021-01-23 03:28:38 -08006088 if (FormatIsDepthOrStencil(image_format)) {
6089 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006090 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006091 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6092 " must be a multiple 4 if using a depth/stencil format (%s).",
6093 function, i, bufferOffset, string_VkFormat(image_format));
6094 }
6095 } else {
6096 // If not depth/stencil and not multi-plane
6097 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
6098 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
6099 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6100 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006101 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006102 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6103 " must be a multiple of this format's texel size (%" PRIu32 ").",
6104 function, i, bufferOffset, element_size);
6105 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006106 }
6107
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006108 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6109 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006110 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006111 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006112 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006113 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006114 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006115 }
6116
6117 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6118 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006119 vuid =
6120 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006121 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006122 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006123 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6124 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006125 }
6126
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006127 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006128 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006129 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006130 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006131 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6132 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006133 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006134 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006135 "zero or <= image subresource width (%d).",
6136 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006137 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006138 }
6139
6140 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006141 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006142 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6143 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006144 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006145 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006146 "zero or <= image subresource height (%d).",
6147 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006148 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006149 }
6150
6151 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006152 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006153 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6154 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006155 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006156 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006157 "zero or <= image subresource depth (%d).",
6158 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006159 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006160 }
6161
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006162 // subresource aspectMask must have exactly 1 bit set
6163 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006164 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006165 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006166 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006167 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006168 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006169 }
6170
6171 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006172 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006173 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006174 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006175 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6176 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006177 }
6178
6179 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006180 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6181 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006182
6183 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006184 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006185 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006186 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006187 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04006188 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006189 }
6190
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006191 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006192 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006193 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006194 image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006195 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006196 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006197 }
6198
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006199 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006200 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6201 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6202 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006203 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006204 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006205 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006206 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6207 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006208 }
6209
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006210 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07006211 uint32_t block_size_in_bytes = FormatElementSize(image_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006212 if (SafeModulo(bufferOffset, block_size_in_bytes) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006213 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006214 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Petr Krausb0d5e592021-05-21 23:37:11 +02006215 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ").",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006216 function, i, bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006217 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006218
6219 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006220 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006221 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006222 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006223 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006224 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006225 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006226 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6227 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006228 }
6229
6230 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006231 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006232 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006233 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006234 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006235 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006236 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6237 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006238 }
6239
6240 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006241 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006242 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006243 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006244 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006245 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006246 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6247 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006248 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006249 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006250
6251 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006252 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006253 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006254 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006255 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006256 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006257 "format has three planes.",
6258 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006259 }
6260
6261 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006262 if (0 ==
6263 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006264 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006265 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006266 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6267 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006268 } else {
6269 // Know aspect mask is valid
6270 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6271 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006272 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006273 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006274 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006275 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006276 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
sfricke-samsung8feecc12021-01-23 03:28:38 -08006277 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006278 string_VkFormat(compatible_format));
6279 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006280 }
6281 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006282
6283 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6284 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6285 assert(command_pool != nullptr);
6286 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6287 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6288 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006289 LogObjectList objlist(cb_node->commandBuffer());
6290 objlist.add(command_pool->commandPool());
6291 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006292 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6293 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6294 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6295 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006296 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6297 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006298 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006299 }
6300
6301 return skip;
6302}
6303
Jeff Leger178b1e52020-10-05 12:22:23 -04006304template <typename BufferImageCopyRegionType>
6305bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6306 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006307 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006308 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006309
6310 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006311 VkExtent3D extent = pRegions[i].imageExtent;
6312 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006313
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006314 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6315 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006316 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006317 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6318 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006319 }
6320
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006321 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006322
6323 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
unknown948b6ba2019-09-19 17:32:54 -06006324 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006325 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006326 if (image_extent.width % block_extent.width) {
6327 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6328 }
6329 if (image_extent.height % block_extent.height) {
6330 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6331 }
6332 if (image_extent.depth % block_extent.depth) {
6333 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6334 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006335 }
6336
Dave Houltonfc1a4052017-04-27 14:32:45 -06006337 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006338 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006339 }
6340 }
6341
6342 return skip;
6343}
6344
Jeff Leger178b1e52020-10-05 12:22:23 -04006345template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006346bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006347 const BufferImageCopyRegionType *pRegions, const char *func_name,
6348 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006349 bool skip = false;
6350
6351 VkDeviceSize buffer_size = buff_state->createInfo.size;
6352
6353 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006354 VkDeviceSize max_buffer_offset =
6355 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6356 if (buffer_size < max_buffer_offset) {
6357 skip |=
Petr Krausb0d5e592021-05-21 23:37:11 +02006358 LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes.", func_name, i, buffer_size);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006359 }
6360 }
6361
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006362 return skip;
6363}
6364
Jeff Leger178b1e52020-10-05 12:22:23 -04006365template <typename BufferImageCopyRegionType>
6366bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6367 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6368 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006369 const auto cb_node = GetCBState(commandBuffer);
6370 const auto src_image_state = GetImageState(srcImage);
6371 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006372
Jeff Leger178b1e52020-10-05 12:22:23 -04006373 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6374 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6375 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6376 const char *vuid;
6377
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006378 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006379
6380 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006381 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006382
6383 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006384 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006385
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006386 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006387
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006388 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006389 vuid =
6390 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6391 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6392 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6393 "or transfer capabilities.",
6394 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006395 }
Jeff Leger178b1e52020-10-05 12:22:23 -04006396 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
6397 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6398 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6399 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006400
Jeff Leger178b1e52020-10-05 12:22:23 -04006401 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6402 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6403 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6404
6405 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6406 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6407 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6408 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006409
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006410 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006411 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6412 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006413 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006414 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6415 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006416 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006417 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6418 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6419 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6420 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6421 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6422 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006423
6424 // Validation for VK_EXT_fragment_density_map
6425 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006426 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006427 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006428 "%s: srcImage must not have been created with flags containing "
6429 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6430 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006431 }
6432
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006433 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006434 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6435 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006436 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006437 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006438
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006439 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04006440 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6441 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6442 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6443 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
6444
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006445 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006446 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6447 vuid =
6448 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006449 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006450 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6451 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6452 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6453 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6454 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6455 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6456 "imageSubresource", vuid);
6457 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6458 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006459 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006460 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006461 }
6462 return skip;
6463}
6464
Jeff Leger178b1e52020-10-05 12:22:23 -04006465bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6466 VkBuffer dstBuffer, uint32_t regionCount,
6467 const VkBufferImageCopy *pRegions) const {
6468 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6469 COPY_COMMAND_VERSION_1);
6470}
6471
6472bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6473 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6474 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6475 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6476 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6477}
6478
John Zulauf1686f232019-07-09 16:27:11 -06006479void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6480 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6481 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6482
6483 auto cb_node = GetCBState(commandBuffer);
6484 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006485 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006486 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006487 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006488 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006489}
6490
Jeff Leger178b1e52020-10-05 12:22:23 -04006491void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6492 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6493 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6494
6495 auto cb_node = GetCBState(commandBuffer);
6496 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6497 // Make sure that all image slices record referenced layout
6498 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6499 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6500 pCopyImageToBufferInfo->srcImageLayout);
6501 }
6502}
6503
6504template <typename RegionType>
6505bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6506 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6507 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006508 const auto cb_node = GetCBState(commandBuffer);
6509 const auto src_buffer_state = GetBufferState(srcBuffer);
6510 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006511
Jeff Leger178b1e52020-10-05 12:22:23 -04006512 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6513 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6514 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6515 const char *vuid;
6516
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006517 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006518
6519 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006520 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006521
Jeff Leger178b1e52020-10-05 12:22:23 -04006522 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
6523 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6524 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6525 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6526
6527 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6528 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6529 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6530 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6531 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6532 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6533 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6534 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6535 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006536 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006537 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6538 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006539 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006540 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6541 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6542 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6543 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6544 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6545 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006546
6547 // Validation for VK_EXT_fragment_density_map
6548 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006549 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006550 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006551 "%s: dstImage must not have been created with flags containing "
6552 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6553 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006554 }
6555
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07006556 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006557 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6558 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006559 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006560 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006561
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006562 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04006563 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6564 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6565 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6566 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
6567
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006568 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006569 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6570 vuid =
6571 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006572 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006573 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6574 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6575 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6576 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6577 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6578 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6579 "imageSubresource", vuid);
6580 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6581 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006582 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006583 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006584
6585 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6586 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6587 assert(command_pool != nullptr);
6588 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6589 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6590 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6591 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6592 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006593 LogObjectList objlist(cb_node->commandBuffer());
6594 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006595 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6596 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006597 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006598 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6599 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6600 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006601 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6602 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006603 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006604 }
6605 return skip;
6606}
6607
Jeff Leger178b1e52020-10-05 12:22:23 -04006608bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6609 VkImageLayout dstImageLayout, uint32_t regionCount,
6610 const VkBufferImageCopy *pRegions) const {
6611 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6612 COPY_COMMAND_VERSION_1);
6613}
6614
6615bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6616 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6617 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6618 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6619 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6620}
6621
John Zulauf1686f232019-07-09 16:27:11 -06006622void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6623 VkImageLayout dstImageLayout, uint32_t regionCount,
6624 const VkBufferImageCopy *pRegions) {
6625 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6626
6627 auto cb_node = GetCBState(commandBuffer);
6628 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006629 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006630 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06006631 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006632 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006633}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006634
Jeff Leger178b1e52020-10-05 12:22:23 -04006635void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6636 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6637 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6638
6639 auto cb_node = GetCBState(commandBuffer);
6640 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6641 // Make sure that all image slices are record referenced layout
6642 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
6643 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6644 pCopyBufferToImageInfo2KHR->dstImageLayout);
6645 }
6646}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006647bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006648 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006649 bool skip = false;
6650 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6651
Dave Houlton1d960ff2018-01-19 12:17:05 -07006652 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006653 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6654 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6655 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006656 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6657 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006658 }
6659
John Zulaufa26d3c82019-08-14 16:09:08 -06006660 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006661 if (!image_entry) {
6662 return skip;
6663 }
6664
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006665 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
6666 if (device_extensions.vk_ext_image_drm_format_modifier) {
6667 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6668 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006669 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6670 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6671 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006672 }
6673 } else {
6674 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006675 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6676 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006677 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006678 }
6679
Dave Houlton1d960ff2018-01-19 12:17:05 -07006680 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006681 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006682 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6683 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6684 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006685 }
6686
Dave Houlton1d960ff2018-01-19 12:17:05 -07006687 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006688 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006689 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6690 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6691 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006692 }
6693
Dave Houlton1d960ff2018-01-19 12:17:05 -07006694 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006695 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006696 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6697 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006698 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006699 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6700 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006701 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006702 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6703 }
6704 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006705 skip |= LogError(image, vuid,
6706 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6707 ") must be a single-plane specifier flag.",
6708 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006709 }
6710 } else if (FormatIsColor(img_format)) {
6711 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006712 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6713 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6714 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006715 }
6716 } else if (FormatIsDepthOrStencil(img_format)) {
6717 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6718 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006719 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006720 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6721 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6722 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6723 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006724 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6725 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6726 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006727 }
6728 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006729
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006730 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006731 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006732 }
6733
Mike Weiblen672b58b2017-02-21 14:32:53 -07006734 return skip;
6735}
sfricke-samsung022fa252020-07-24 03:26:16 -07006736
6737// Validates the image is allowed to be protected
6738bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006739 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006740 bool skip = false;
6741 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006742 LogObjectList objlist(cb_state->commandBuffer());
6743 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006744 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006745 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6746 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006747 }
6748 return skip;
6749}
6750
6751// Validates the image is allowed to be unprotected
6752bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006753 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006754 bool skip = false;
6755 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006756 LogObjectList objlist(cb_state->commandBuffer());
6757 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006758 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006759 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6760 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006761 }
6762 return skip;
6763}
6764
6765// Validates the buffer is allowed to be protected
6766bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006767 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006768 bool skip = false;
6769 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006770 LogObjectList objlist(cb_state->commandBuffer());
6771 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006772 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006773 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6774 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006775 }
6776 return skip;
6777}
6778
6779// Validates the buffer is allowed to be unprotected
6780bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006781 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006782 bool skip = false;
6783 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006784 LogObjectList objlist(cb_state->commandBuffer());
6785 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006786 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006787 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6788 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006789 }
6790 return skip;
6791}