blob: d540bc8a9fa985c57e6d9068eb36df7911ed5ce6 [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", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070070 "VUID-vkCmdCopyBufferToImage-pRegions-06218",
71 "VUID-vkCmdCopyImageToBuffer-pRegions-06221",
72 "VUID-VkCopyBufferToImageInfo2KHR-pRegions-06223",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070073 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
74 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070075 {"00198", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070076 "VUID-vkCmdCopyBufferToImage-pRegions-06219",
77 "VUID-vkCmdCopyImageToBuffer-pRegions-06222",
78 "VUID-VkCopyBufferToImageInfo2KHR-pRegions-06224",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070079 "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
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700180static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200181 switch (layout) {
182 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
183 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
184 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
185
186 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
187 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
188 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
189
190 default:
191 return layout;
192 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700193}
194
195static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200196 switch (layout) {
197 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
198 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
199 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
200
201 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
202 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
203 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
204
205 default:
206 return layout;
207 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700208}
209
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700210static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
211 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
212 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
213 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
214 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
215 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
216 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
217 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
218 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
219 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
220 }
221 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
222 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
223 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
224 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
225 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
226 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
227 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
228 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
229 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
230 }
231 }
232 return layout;
233}
234
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700235static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
236 bool matches = (a == b);
237 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700238 a = NormalizeSynchronization2Layout(aspect_mask, a);
239 b = NormalizeSynchronization2Layout(aspect_mask, b);
240 matches = (a == b);
241 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200242 // Relaxed rules when referencing *only* the depth or stencil aspects.
243 // When accessing both, normalize layouts for aspects separately.
244 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
245 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
246 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
247 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700248 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
249 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
250 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
251 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700252 }
253 }
254 return matches;
255}
256
257// Utility type for ForRange callbacks
258struct LayoutUseCheckAndMessage {
259 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
260 const ImageSubresourceLayoutMap *layout_map;
261 const VkImageAspectFlags aspect_mask;
262 const char *message;
263 VkImageLayout layout;
264
265 LayoutUseCheckAndMessage() = delete;
266 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
267 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
268 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
269 message = nullptr;
270 layout = kInvalidLayout; // Success status
271 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
272 message = "previous known";
273 layout = current_layout;
274 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
275 // To check the relaxed rule matching we need to see how the initial use was used
276 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
277 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
278 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
279 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
280 message = "previously used";
281 layout = initial_layout;
282 }
283 }
284 return layout == kInvalidLayout;
285 }
286};
287
locke-lunarg540b2252020-08-03 13:23:36 -0600288bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600289 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600290 return true;
291 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600292 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600293 return false;
294 }
locke-lunarg540b2252020-08-03 13:23:36 -0600295 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
296 return false;
297 }
298
299 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600300 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600301 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600302 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600303 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600304 }
305
306 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600307 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600308 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600309 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600310 }
311
312 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600313 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600314 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600315 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600316 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600317 }
318
319 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600320 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600321 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600322 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600323 }
locke-lunargdc287022020-08-21 12:03:57 -0600324 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600325}
326
Dave Houltond9611312018-11-19 17:03:36 -0700327uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
328 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700329 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700330}
331
332uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
333
334uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
335
John Zulauf2d60a452021-03-04 15:12:03 -0700336bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben6335df62021-11-01 10:50:13 -0600337 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state);
John Zulauf2076e812020-01-08 14:55:54 -0700338 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700339 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
340 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
341
John Zulauf2076e812020-01-08 14:55:54 -0700342 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
343
344 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700345 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700346 return false;
347 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700348
John Zulauf79f06582021-02-27 18:38:39 -0700349 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700350 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700351 }
352 return true;
353}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700354
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700355bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600356 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700357 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600358 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100359 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600360 const auto &image_view = image_view_state.Handle();
361 const auto *image_state = image_view_state.image_state.get();
362 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100363 const char *vuid;
364 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700365 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100366
367 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600368 LogObjectList objlist(image);
369 objlist.add(renderpass);
370 objlist.add(framebuffer);
371 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700372 skip |=
373 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
374 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
375 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
376 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 return skip;
378 }
379
380 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700381 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200382 if (stencil_usage_info) {
383 image_usage |= stencil_usage_info->stencilUsage;
384 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100385
386 // Check for layouts that mismatch image usages in the framebuffer
387 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800388 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600389 LogObjectList objlist(image);
390 objlist.add(renderpass);
391 objlist.add(framebuffer);
392 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700393 skip |= LogError(objlist, vuid,
394 "%s: Layout/usage mismatch for attachment %u in %s"
395 " - the %s is %s but the image attached to %s via %s"
396 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
397 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
398 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
399 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100400 }
401
402 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
403 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800404 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600405 LogObjectList objlist(image);
406 objlist.add(renderpass);
407 objlist.add(framebuffer);
408 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700409 skip |= LogError(objlist, vuid,
410 "%s: Layout/usage mismatch for attachment %u in %s"
411 " - the %s is %s but the image attached to %s via %s"
412 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
413 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
414 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
415 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100416 }
417
418 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800419 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600420 LogObjectList objlist(image);
421 objlist.add(renderpass);
422 objlist.add(framebuffer);
423 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700424 skip |= LogError(objlist, vuid,
425 "%s: Layout/usage mismatch for attachment %u in %s"
426 " - the %s is %s but the image attached to %s via %s"
427 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
428 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
429 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
430 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100431 }
432
433 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800434 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600435 LogObjectList objlist(image);
436 objlist.add(renderpass);
437 objlist.add(framebuffer);
438 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700439 skip |= LogError(objlist, vuid,
440 "%s: Layout/usage mismatch for attachment %u in %s"
441 " - the %s is %s but the image attached to %s via %s"
442 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
443 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
444 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
445 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100446 }
447
sfricke-samsung45996a42021-09-16 13:45:27 -0700448 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100449 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
450 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
451 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
452 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
453 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800454 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600455 LogObjectList objlist(image);
456 objlist.add(renderpass);
457 objlist.add(framebuffer);
458 objlist.add(image_view);
459 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700460 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700461 " - the %s is %s but the image attached to %s via %s"
462 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700463 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700464 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
465 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466 }
467 } else {
468 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
469 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
470 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
471 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600472 LogObjectList objlist(image);
473 objlist.add(renderpass);
474 objlist.add(framebuffer);
475 objlist.add(image_view);
476 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700477 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700478 " - the %s is %s but the image attached to %s via %s"
479 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700480 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700481 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
482 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100483 }
484 }
485 return skip;
486}
487
John Zulauf17a01bb2019-08-09 16:41:19 -0600488bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700489 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600490 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600491 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700492 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
493 auto const &framebuffer_info = framebuffer_state->createInfo;
494 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100495
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600496 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass();
497 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100498
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700499 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600500 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700501 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700502 }
John Zulauf8e308292018-09-21 11:34:37 -0600503
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700504 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800505 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700506 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100507 }
508
Tobias Hectorc9057422019-07-23 12:15:52 +0100509 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700510 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
511 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100512 auto image_view = attachments[i];
513 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100514
Tobias Hectorc9057422019-07-23 12:15:52 +0100515 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600516 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600517 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600518 objlist.add(image_view);
519 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700520 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600521 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700522 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100523 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100524 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100525
526 const VkImage image = view_state->create_info.image;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600527 const auto *image_state = view_state->image_state.get();
Tobias Hectorc9057422019-07-23 12:15:52 +0100528
529 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600530 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600531 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600532 objlist.add(image_view);
533 objlist.add(image);
534 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700535 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600536 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700537 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100538 continue;
539 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700540 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
541 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100542
Piers Daniell7f894f62020-01-09 16:33:48 -0700543 // Default to expecting stencil in the same layout.
544 auto attachment_stencil_initial_layout = attachment_initial_layout;
545
546 // If a separate layout is specified, look for that.
547 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700548 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700549 if (attachment_description_stencil_layout) {
550 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
551 }
552
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200553 const ImageSubresourceLayoutMap *subresource_map = nullptr;
554 bool has_queried_map = false;
555 bool subres_skip = false;
Tobias Hectorc9057422019-07-23 12:15:52 +0100556
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200557 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
558 VkImageAspectFlags test_aspect = 1u << aspect_index;
559 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
560 continue;
561 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700562
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200563 // Allow for differing depth and stencil layouts
564 VkImageLayout check_layout = attachment_initial_layout;
565 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
566 check_layout = attachment_stencil_initial_layout;
567 }
568
569 if (check_layout != VK_IMAGE_LAYOUT_UNDEFINED) { // If no layout information for image yet, will be checked at QueueSubmit time
570 if (!has_queried_map) {
571 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
572 // in common with the non-const version.)
573 // The lookup is expensive, so cache it.
Jeremy Gebben6335df62021-11-01 10:50:13 -0600574 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200575 has_queried_map = true;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200576 }
John Zulauf5e617452019-11-19 14:44:16 -0700577
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200578 if (subresource_map) {
579 auto normalized_range = view_state->normalized_subresource_range;
580 normalized_range.aspectMask = test_aspect;
581 auto pos = subresource_map->Find(normalized_range);
582 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200583
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200584 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
585 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
586 const VkImageSubresource &subres = pos->subresource;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200587
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200588 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
589 subres_skip |= LogError(
590 device, kVUID_Core_DrawState_InvalidRenderpass,
591 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
592 "and the %s layout of the attachment is %s. The layouts must match, or the render "
593 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
594 i, string_VkImageLayout(check_layout), layout_check.message,
595 string_VkImageLayout(layout_check.layout));
596 }
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200597 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100598 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700599 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100600 }
601
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200602 skip |= subres_skip;
603
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600604 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state, framebuffer,
605 render_pass, i, "initial layout");
Tobias Hectorc9057422019-07-23 12:15:52 +0100606
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600607 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer, render_pass, i,
608 "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100609 }
610
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700611 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
612 auto &subpass = render_pass_info->pSubpasses[j];
613 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100614 auto &attachment_ref = subpass.pInputAttachments[k];
615 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
616 auto image_view = attachments[attachment_ref.attachment];
617 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100618
Tobias Hectorc9057422019-07-23 12:15:52 +0100619 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600620 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700621 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100622 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100623 }
624 }
625 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100626
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700627 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100628 auto &attachment_ref = subpass.pColorAttachments[k];
629 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
630 auto image_view = attachments[attachment_ref.attachment];
631 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100632
Tobias Hectorc9057422019-07-23 12:15:52 +0100633 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600634 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Tobias Hectorc9057422019-07-23 12:15:52 +0100635 framebuffer, render_pass, attachment_ref.attachment,
636 "color attachment layout");
637 if (subpass.pResolveAttachments) {
638 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600639 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
640 "resolve attachment layout");
Tobias Hectorc9057422019-07-23 12:15:52 +0100641 }
642 }
643 }
644 }
645
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700646 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100647 auto &attachment_ref = *subpass.pDepthStencilAttachment;
648 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
649 auto image_view = attachments[attachment_ref.attachment];
650 auto view_state = GetImageViewState(image_view);
651
652 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600653 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Tobias Hectorc9057422019-07-23 12:15:52 +0100654 framebuffer, render_pass, attachment_ref.attachment,
655 "input attachment layout");
656 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100657 }
658 }
659 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700660 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600661 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700662}
663
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600664void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700665 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700666 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600667 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600668 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700669 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700670 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700671 if (attachment_reference_stencil_layout) {
672 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
673 }
674
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600675 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600676 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700677 }
678}
679
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600680void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
681 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700682 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700683
684 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700685 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700686 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700687 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700688 }
689 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700690 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700691 }
692 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700693 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700694 }
695 }
696}
697
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700698// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
699// 1. Transition into initialLayout state
700// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600701void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700702 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700703 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700704 auto const rpci = render_pass_state->createInfo.ptr();
705 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600706 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600707 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700708 IMAGE_STATE *image_state = view_state->image_state.get();
709 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700710 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700711 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700712 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700713 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
714 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
715 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600716 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700717 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600718 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700719 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600720 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700721 }
John Zulauf8e308292018-09-21 11:34:37 -0600722 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700723 }
724 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700725 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700726}
727
Dave Houlton10b39482017-03-16 13:18:15 -0600728bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600729 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600730 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600731 }
732 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600733 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600734 }
735 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600736 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600737 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800738 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 -0700739 if (FormatPlaneCount(format) == 1) return false;
740 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600741 return true;
742}
743
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700744// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
745// but some features/extensions can explicitly turn that restriction off
746// The implicit check is done in format utils, while feature checks are done here in CoreChecks
747bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
748 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
749 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
750 return false;
751 }
752 return FormatRequiresYcbcrConversion(format);
753}
754
Mike Weiblen62d08a32017-03-07 22:18:27 -0700755// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700756bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700757 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700758 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700759 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700760 switch (layout) {
761 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700762 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700763 break;
764 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700765 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700766 break;
767 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700768 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700769 break;
770 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700771 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700772 break;
773 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700774 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700775 break;
776 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700777 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600779 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700780 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500781 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700782 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700783 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700784 break;
785 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700786 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700787 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700788 default:
789 // Other VkImageLayout values do not have VUs defined in this context.
790 break;
791 }
792
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700793 if (is_error) {
794 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
795
796 skip |=
797 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
798 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700799 }
800 return skip;
801}
802
803// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700804template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700805bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700806 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700807 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700808 using sync_vuid_maps::GetImageBarrierVUID;
809 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200810
John Zulauf463c51e2018-05-31 13:29:20 -0600811 // Scoreboard for duplicate layout transition barriers within the list
812 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200813 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
814 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600815
Mike Weiblen62d08a32017-03-07 22:18:27 -0700816 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700817 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200818 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700819
Petr Krausad0096a2019-08-09 18:35:04 +0200820 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600821 if (image_state) {
822 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700823 skip |=
824 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
825 skip |=
826 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600827
828 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
829 if (image_state->layout_locked) {
830 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700831 skip |= LogError(
832 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700833 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600834 " 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 -0700835 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
836 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600837 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600838
John Zulaufa4472282019-08-22 14:44:34 -0600839 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700840 const VkFormat image_format = image_create_info.format;
841 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600842 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700843 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700844 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700845 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600846 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700847 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
848 skip |= LogError(img_barrier.image, vuid,
849 "%s references %s of format %s that must have either the depth or stencil "
850 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
851 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
852 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600853 }
854 } else {
855 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
856 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700857 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700858 ? ImageError::kNotSeparateDepthAndStencilAspect
859 : ImageError::kNotDepthAndStencilAspect;
860 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700861 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700862 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700863 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700864 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700865 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600866 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700867 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700868 }
John Zulauff660ad62019-03-23 07:16:05 -0600869
Petr Krausad0096a2019-08-09 18:35:04 +0200870 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600871 // TODO: Set memory invalid which is in mem_tracker currently
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200872 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
Jeremy Gebben6335df62021-11-01 10:50:13 -0600873 auto &write_subresource_map = layout_updates[image_state];
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200874 bool new_write = false;
875 if (!write_subresource_map) {
876 write_subresource_map.emplace(*image_state);
877 new_write = true;
878 }
Jeremy Gebben6335df62021-11-01 10:50:13 -0600879 const auto &current_subresource_map = current_map.find(image_state);
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200880 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
881 ? (*current_subresource_map).second
882 : write_subresource_map;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200883
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200884 bool subres_skip = false;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200885 // Validate aspects in isolation.
886 // This is required when handling separate depth-stencil layouts.
887 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
888 VkImageAspectFlags test_aspect = 1u << aspect_index;
889 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
890 continue;
891 }
892
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200893 LayoutUseCheckAndMessage layout_check(&read_subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200894 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
895 normalized_isr.aspectMask = test_aspect;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200896 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200897 for (auto pos = read_subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip;
898 pos.IncrementInterval()) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200899 const auto &value = *pos;
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200900 auto old_layout = NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200901 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
902 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
903 subres_skip =
904 LogError(cb_state->commandBuffer(), vuid,
905 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
906 "%s layout is %s.",
907 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
908 value.subresource.aspectMask, value.subresource.mipLevel, value.subresource.arrayLayer,
909 string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
910 string_VkImageLayout(layout_check.layout));
911 }
John Zulauff660ad62019-03-23 07:16:05 -0600912 }
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200913 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
John Zulauf5e617452019-11-19 14:44:16 -0700914 }
John Zulauff660ad62019-03-23 07:16:05 -0600915 skip |= subres_skip;
916 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700917
918 // checks color format and (single-plane or non-disjoint)
919 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
920 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700921 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700922 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700923 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
924 : ImageError::kNotColorAspectYcbcr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700925 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -0700926 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700927 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -0700928 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700929 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700930 string_VkFormat(image_format), aspect_mask);
931 }
932 }
933
934 VkImageAspectFlags valid_disjoint_mask =
935 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 -0700936 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700937 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700938 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
939 skip |= LogError(img_barrier.image, vuid,
940 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -0700941 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700942 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700943 string_VkFormat(image_format), aspect_mask);
944 }
945
946 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700947 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
948 skip |= LogError(img_barrier.image, vuid,
949 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -0700950 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700951 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700952 string_VkFormat(image_format), aspect_mask);
953 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700954 }
955 }
956 return skip;
957}
958
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700959template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700960bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700961 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600962 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700963 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -0600964 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700965 if (!IsTransferOp(barrier)) {
966 return skip;
967 }
968 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600969 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 const auto found = barrier_sets.release.find(barrier);
971 if (found != barrier_sets.release.cend()) {
972 barrier_record = &(*found);
973 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -0600974 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600975 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700976 const auto found = barrier_sets.acquire.find(barrier);
977 if (found != barrier_sets.acquire.cend()) {
978 barrier_record = &(*found);
979 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -0600980 }
981 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700982 if (barrier_record != nullptr) {
983 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600984 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700985 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
986 " duplicates existing barrier recorded in this command buffer.",
987 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
988 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
989 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600990 return skip;
991}
992
John Zulaufa4472282019-08-22 14:44:34 -0600993VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
994 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
995}
996
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700997VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
998 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
999}
1000
John Zulaufa4472282019-08-22 14:44:34 -06001001const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1002 return device_state.GetImageState(barrier.image);
1003}
1004
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001005const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1006 return device_state.GetImageState(barrier.image);
1007}
1008
John Zulaufa4472282019-08-22 14:44:34 -06001009VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1010 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1011}
1012
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001013VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1014 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1015}
1016
John Zulaufa4472282019-08-22 14:44:34 -06001017const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1018 return device_state.GetBufferState(barrier.buffer);
1019}
1020
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001021const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1022 return device_state.GetBufferState(barrier.buffer);
1023}
John Zulaufa4472282019-08-22 14:44:34 -06001024
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001025template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001026void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001027 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001028 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001029 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001030 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001031 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001032 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001033 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001034 }
John Zulaufa4472282019-08-22 14:44:34 -06001035
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001036 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1037 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001038 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1039 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001040 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1041
1042 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001043 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1044 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1045 auto handle_state = BarrierHandleState(*this, barrier);
1046 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1047 if (!mode_concurrent) {
1048 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001049 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001050 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001051 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1052 const QUEUE_STATE *queue_state) {
1053 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001054 src_queue_family, dst_queue_family);
1055 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001056 }
1057 }
1058}
1059
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001060// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001061template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001062bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001063 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1064 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001065 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1066 using sync_vuid_maps::GetImageBarrierVUID;
1067 using sync_vuid_maps::ImageError;
1068
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001069 bool skip = false;
1070 const auto *fb_state = framebuffer;
1071 assert(fb_state);
1072 const auto img_bar_image = img_barrier.image;
1073 bool image_match = false;
1074 bool sub_image_found = false; // Do we find a corresponding subpass description
1075 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1076 uint32_t attach_index = 0;
1077 // Verify that a framebuffer image matches barrier image
1078 const auto attachment_count = fb_state->createInfo.attachmentCount;
1079 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001080 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001081 if (view_state && (img_bar_image == view_state->create_info.image)) {
1082 image_match = true;
1083 attach_index = attachment;
1084 break;
1085 }
1086 }
1087 if (image_match) { // Make sure subpass is referring to matching attachment
1088 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1089 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1090 sub_image_found = true;
1091 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001092 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001093 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1094 if (resolve && resolve->pDepthStencilResolveAttachment &&
1095 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1096 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1097 sub_image_found = true;
1098 }
1099 }
1100 if (!sub_image_found) {
1101 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1102 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1103 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1104 sub_image_found = true;
1105 break;
1106 }
1107 if (!sub_image_found && sub_desc.pResolveAttachments &&
1108 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1109 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1110 sub_image_found = true;
1111 break;
1112 }
1113 }
1114 }
1115 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001116 auto img_loc = loc.dot(Field::image);
1117 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1118 skip |=
1119 LogError(rp_handle, vuid,
1120 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1121 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1122 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001123 }
1124 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001125 auto img_loc = loc.dot(Field::image);
1126 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001127 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 -07001128 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001129 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001130 }
1131 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001132 auto layout_loc = loc.dot(Field::oldLayout);
1133 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001134 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001135 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001136 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001137 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001138 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1139 } else {
1140 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1141 LogObjectList objlist(rp_handle);
1142 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001143 auto layout_loc = loc.dot(Field::oldLayout);
1144 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1145 skip |= LogError(objlist, vuid,
1146 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001147 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001148 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001149 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1150 string_VkImageLayout(img_barrier.oldLayout));
1151 }
1152 }
1153 return skip;
1154}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001155// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001156template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001157 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1158 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1159 const VkImageMemoryBarrier &img_barrier,
1160 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001161template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001162 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1163 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1164 const VkImageMemoryBarrier2KHR &img_barrier,
1165 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001166
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001167template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001168void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001169 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001170 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1171 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1172 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1173 const auto active_subpass = cb_state->activeSubpass;
1174 const auto rp_state = cb_state->activeRenderPass;
1175 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001176 // Secondary CB case w/o FB specified delay validation
1177 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001178 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001179 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001180 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001181 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1182 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1183 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001184 render_pass, barrier, primary_cb);
1185 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001186 }
1187}
1188
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001189void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001190 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1191 const VkImageMemoryBarrier *pImageMemBarriers) {
1192 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001193 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001194 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1195 }
1196 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001197 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001198 const auto &img_barrier = pImageMemBarriers[i];
1199 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1200 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1201 }
1202}
1203
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001204void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001205 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001206 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001207 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1208 }
1209 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001210 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001211 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1212 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1213 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1214 }
1215}
1216
1217template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001218bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001219 const char *operation, const TransferBarrier &barrier,
1220 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001221 // Record to the scoreboard or report that we have a duplication
1222 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001223 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001224 if (!inserted.second && inserted.first->second != cb_state) {
1225 // 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 -06001226 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001227 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001228 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001229 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001230 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1231 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001232 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001233 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001234 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001235 }
1236 return skip;
1237}
1238
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001239template <typename TransferBarrier>
1240bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1241 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1242 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001243 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001244 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001245 const char *barrier_name = TransferBarrier::BarrierName();
1246 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001247 // No release should have an extant duplicate (WARNING)
1248 for (const auto &release : cb_barriers.release) {
1249 // Check the global pending release barriers
1250 const auto set_it = global_release_barriers.find(release.handle);
1251 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001252 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001253 const auto found = set_for_handle.find(release);
1254 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001255 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001256 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1257 " to dstQueueFamilyIndex %" PRIu32
1258 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1259 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1260 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001261 }
1262 }
1263 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1264 }
1265 // Each acquire must have a matching release (ERROR)
1266 for (const auto &acquire : cb_barriers.acquire) {
1267 const auto set_it = global_release_barriers.find(acquire.handle);
1268 bool matching_release_found = false;
1269 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001270 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001271 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1272 }
1273 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001274 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001275 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1276 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1277 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1278 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001279 }
1280 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1281 }
1282 return skip;
1283}
1284
John Zulauf3b04ebd2019-07-18 14:08:11 -06001285bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001286 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1287 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001288 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001289 skip |=
1290 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1291 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1292 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001293 return skip;
1294}
1295
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001296template <typename TransferBarrier>
1297void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1298 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001299 // Add release barriers from this submit to the global map
1300 for (const auto &release : cb_barriers.release) {
1301 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1302 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1303 global_release_barriers[release.handle].insert(release);
1304 }
1305
1306 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1307 for (const auto &acquire : cb_barriers.acquire) {
1308 // NOTE: We're not using [] because we don't want to create entries for missing releases
1309 auto set_it = global_release_barriers.find(acquire.handle);
1310 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001311 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001312 set_for_handle.erase(acquire);
1313 if (set_for_handle.size() == 0) { // Clean up empty sets
1314 global_release_barriers.erase(set_it);
1315 }
1316 }
1317 }
1318}
1319
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001320void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001321 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1322 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1323 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001324}
1325
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001326template <typename ImgBarrier>
1327void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1328 // For ownership transfers, the barrier is specified twice; as a release
1329 // operation on the yielding queue family, and as an acquire operation
1330 // on the acquiring queue family. This barrier may also include a layout
1331 // transition, which occurs 'between' the two operations. For validation
1332 // purposes it doesn't seem important which side performs the layout
1333 // transition, but it must not be performed twice. We'll arbitrarily
1334 // choose to perform it as part of the acquire operation.
1335 //
1336 // However, we still need to record initial layout for the "initial layout" validation
1337 for (uint32_t i = 0; i < barrier_count; i++) {
1338 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001339 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001340 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001341 if (image_state) {
1342 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1343 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001344 }
1345}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001346// explictly instantiate this template so it can be used in core_validation.cpp
1347template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1348 const VkImageMemoryBarrier *barrier);
1349template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1350 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001351
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001352VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1353
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001354template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001355void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001356 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001357 if (enabled_features.synchronization2_features.synchronization2) {
1358 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1359 return;
1360 }
1361 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001362 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001363
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001364 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1365 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001366
1367 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001368 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001369 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1370 }
1371
John Zulauf2be3fe02019-12-30 09:48:02 -07001372 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001373 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001374 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001375 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001376 }
unknown86bcb3a2019-07-11 13:05:36 -06001377}
1378
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001379bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1380 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1381 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1382 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001383 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001384 assert(cb_node);
1385 assert(image_state);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001386 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001387
Jeremy Gebben6335df62021-11-01 10:50:13 -06001388 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06001389 if (subresource_map) {
1390 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001391 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001392 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1393 // the next "constant value" range
1394 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001395 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001396 *error = true;
Jeremy Gebben6335df62021-11-01 10:50:13 -06001397 subres_skip |=
1398 LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
1399 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1400 "%s layout %s.",
1401 caller, report_data->FormatHandle(image_state->Handle()).c_str(), pos->subresource.arrayLayer,
1402 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1403 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001404 }
John Zulauf5e617452019-11-19 14:44:16 -07001405 }
John Zulauff660ad62019-03-23 07:16:05 -06001406 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001407 }
John Zulauff660ad62019-03-23 07:16:05 -06001408
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001409 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1410 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1411 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001412 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1413 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001414 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001415 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001416 report_data->FormatHandle(image_state->Handle()).c_str(),
1417 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001418 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001419 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001420 if (image_state->shared_presentable) {
1421 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001422 skip |=
1423 LogError(device, layout_invalid_msg_code,
1424 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1425 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001426 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001427 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001428 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001429 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001430 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001431 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001432 report_data->FormatHandle(image_state->Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001433 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001434 }
1435 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001436 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001437}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001438bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001439 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1440 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001441 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001442 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1443 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1444}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001445
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001446void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001447 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001448 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1449 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001450
Mike Schuchardt2df08912020-12-15 16:28:09 -08001451 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001452 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001453 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001454 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001455 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001456 VkImageLayout stencil_layout = kInvalidLayout;
1457 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001458 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001459 if (attachment_description_stencil_layout) {
1460 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1461 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001462 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001463 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001464 }
1465 }
1466}
Dave Houltone19e20d2018-02-02 16:32:41 -07001467
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001468#ifdef VK_USE_PLATFORM_ANDROID_KHR
1469// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1470// This could also move into a seperate core_validation_android.cpp file... ?
1471
1472//
1473// AHB-specific validation within non-AHB APIs
1474//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001475bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001476 bool skip = false;
1477
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001478 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001479 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001480 if (0 != ext_fmt_android->externalFormat) {
1481 if (VK_FORMAT_UNDEFINED != create_info->format) {
1482 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001483 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1484 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1485 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001486 }
1487
1488 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001489 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1490 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1491 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001492 }
1493
1494 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001495 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1496 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001497 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001498 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001499 }
1500
1501 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001502 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1503 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1504 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001505 }
1506 }
1507
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001508 if ((0 != ext_fmt_android->externalFormat) &&
1509 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001510 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001511 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1512 ") which has "
1513 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1514 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001515 }
1516 }
1517
Dave Houltond9611312018-11-19 17:03:36 -07001518 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001519 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001520 skip |=
1521 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1522 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1523 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001524 }
1525 }
1526
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001527 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001528 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1529 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001530 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001531 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1532 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1533 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1534 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001535 }
1536
1537 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001538 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1539 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1540 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1541 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1542 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001543 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001544 }
1545
1546 return skip;
1547}
1548
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001549bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001550 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001551 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001552
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001553 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001554 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001555 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1556 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001557 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001558 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001559 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001560
Dave Houltond9611312018-11-19 17:03:36 -07001561 // Chain must include a compatible ycbcr conversion
1562 bool conv_found = false;
1563 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001564 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001565 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001566 auto ycbcr_state = GetSamplerYcbcrConversionState(ycbcr_conv_info->conversion);
1567 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001568 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001569 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001570 }
Dave Houltond9611312018-11-19 17:03:36 -07001571 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001572 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001573 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001574 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1575 "an externalFormat (%" PRIu64
1576 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1577 "with the same external format.",
1578 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001579 }
1580
1581 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001582 if (IsIdentitySwizzle(create_info->components) == false) {
1583 skip |= LogError(
1584 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1585 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1586 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1587 "= %s.",
1588 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1589 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001590 }
1591 }
Dave Houltond9611312018-11-19 17:03:36 -07001592
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001593 return skip;
1594}
1595
John Zulaufa26d3c82019-08-14 16:09:08 -06001596bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001597 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001598
John Zulaufa26d3c82019-08-14 16:09:08 -06001599 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001600 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001601 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001602 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1603 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1604 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1605 "bound to memory.");
1606 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001607 }
1608 return skip;
1609}
1610
1611#else
1612
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001613bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001614 return false;
1615}
1616
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001617bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001618
John Zulaufa26d3c82019-08-14 16:09:08 -06001619bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001620
1621#endif // VK_USE_PLATFORM_ANDROID_KHR
1622
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001623bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1624 bool skip = false;
1625
1626 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1627 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1628 const VkImageTiling image_tiling = pCreateInfo->tiling;
1629 const VkFormat image_format = pCreateInfo->format;
1630
1631 if (image_format == VK_FORMAT_UNDEFINED) {
1632 // VU 01975 states format can't be undefined unless an android externalFormat
1633#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001634 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001635 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1636 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1637 if (it != ahb_ext_formats_map.end()) {
1638 tiling_features = it->second;
1639 }
1640 }
1641#endif
1642 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1643 uint64_t drm_format_modifier = 0;
1644 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001645 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001646 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001647 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001648
1649 if (drm_explicit != nullptr) {
1650 drm_format_modifier = drm_explicit->drmFormatModifier;
1651 } else {
1652 // VUID 02261 makes sure its only explict or implict in parameter checking
1653 assert(drm_implicit != nullptr);
1654 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1655 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1656 }
1657 }
1658
1659 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1660 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1661 nullptr};
1662 format_properties_2.pNext = (void *)&drm_properties_list;
1663 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001664 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1665 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1666 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1667 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001668
1669 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1670 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1671 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1672 }
1673 }
1674 } else {
1675 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1676 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1677 : format_properties.optimalTilingFeatures;
1678 }
1679
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001680 // Lack of disjoint format feature support while using the flag
1681 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1682 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1683 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1684 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1685 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1686 string_VkFormat(pCreateInfo->format));
1687 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001688
1689 return skip;
1690}
1691
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001692bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001693 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001694 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001695
sfricke-samsung45996a42021-09-16 13:45:27 -07001696 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001697 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001698 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1699 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001700 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1701 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001702 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001703 }
1704
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001705 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1706 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001707 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1708 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1709 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001710 }
Dave Houlton130c0212018-01-29 13:39:56 -07001711 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001712
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001713 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001714 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1715 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1716 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001717 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001718 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1719 "device maxFramebufferWidth (%u).",
1720 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001721 }
1722
1723 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001724 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001725 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1726 "device maxFramebufferHeight (%u).",
1727 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001728 }
1729
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001730 VkImageCreateFlags sparseFlags =
1731 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1732 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1733 skip |= LogError(
1734 device, "VUID-VkImageCreateInfo-None-01925",
1735 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1736 }
1737
sfricke-samsung45996a42021-09-16 13:45:27 -07001738 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map) ||
1739 IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001740 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1741 static_cast<float>(device_limits->maxFramebufferWidth) /
1742 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001743 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1744 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001745 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1746 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1747 "ceiling of device "
1748 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1749 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1750 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001751 }
1752
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001753 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1754 static_cast<float>(device_limits->maxFramebufferHeight) /
1755 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001756 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1757 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001758 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1759 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1760 "ceiling of device "
1761 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1762 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1763 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001764 }
1765 }
1766
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001767 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001768 VkResult result = VK_SUCCESS;
1769 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1770 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1771 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1772 &format_limits);
1773 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001774 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1775 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001776 if (modifier_list) {
1777 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001778 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001779 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001780 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001781 image_format_info.type = pCreateInfo->imageType;
1782 image_format_info.format = pCreateInfo->format;
1783 image_format_info.tiling = pCreateInfo->tiling;
1784 image_format_info.usage = pCreateInfo->usage;
1785 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001786 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001787
1788 result =
1789 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1790 format_limits = image_format_properties.imageFormatProperties;
1791
1792 /* The application gives a list of modifier and the driver
1793 * selects one. If one is wrong, stop there.
1794 */
1795 if (result != VK_SUCCESS) break;
1796 }
1797 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001798 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001799 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001800 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001801 image_format_info.type = pCreateInfo->imageType;
1802 image_format_info.format = pCreateInfo->format;
1803 image_format_info.tiling = pCreateInfo->tiling;
1804 image_format_info.usage = pCreateInfo->usage;
1805 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001806 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001807
1808 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1809 format_limits = image_format_properties.imageFormatProperties;
1810 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001811 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001812
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001813 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1814 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1815 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1816 if (result != VK_SUCCESS) {
1817 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001818#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001819 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001820#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001821 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001822 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001823 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1824 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001825#ifdef VK_USE_PLATFORM_ANDROID_KHR
1826 }
1827#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001828 } else {
1829 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1830 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001831 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1832 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1833 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001834 }
Dave Houlton130c0212018-01-29 13:39:56 -07001835
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001836 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1837 static_cast<uint64_t>(pCreateInfo->extent.height) *
1838 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1839 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001840
sfricke-samsung2e827212021-09-28 07:52:08 -07001841 // Depth/Stencil formats size can't be accurately calculated
1842 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1843 uint64_t total_size =
1844 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001845
sfricke-samsung2e827212021-09-28 07:52:08 -07001846 // Round up to imageGranularity boundary
1847 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1848 uint64_t ig_mask = image_granularity - 1;
1849 total_size = (total_size + ig_mask) & ~ig_mask;
1850
1851 if (total_size > format_limits.maxResourceSize) {
1852 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1853 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1854 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1855 total_size, format_limits.maxResourceSize);
1856 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001857 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001858
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001859 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001860 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1861 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1862 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001863 }
1864
1865 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001866 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1867 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1868 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001869 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001870
1871 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1872 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1873 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1874 pCreateInfo->extent.width, format_limits.maxExtent.width);
1875 }
1876
1877 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1878 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1879 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1880 pCreateInfo->extent.height, format_limits.maxExtent.height);
1881 }
1882
1883 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1884 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1885 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1886 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1887 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001888 }
1889
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001890 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001891 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001892 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001893 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001894 ? "VUID-VkImageCreateInfo-format-06414"
1895 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001896 skip |= LogError(device, error_vuid,
1897 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1898 "YCbCr Conversion format, arrayLayers must be 1",
1899 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001900 }
1901
1902 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001903 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001904 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1905 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001906 }
1907
1908 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001909 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001910 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001911 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1912 string_VkSampleCountFlagBits(pCreateInfo->samples));
1913 }
1914
1915 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001916 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001917 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001918 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1919 string_VkImageType(pCreateInfo->imageType));
1920 }
1921 }
1922
sfricke-samsung45996a42021-09-16 13:45:27 -07001923 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001924 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001925 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001926 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1927 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001928 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001929 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001930 }
1931 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001932 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1933 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1934 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001935 }
1936 }
1937 }
1938
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001939 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001940 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1941 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1942 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001943 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001944 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001945 }
1946
unknown2c877272019-07-11 12:56:50 -06001947 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1948 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1949 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001950 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1951 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1952 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001953 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001954
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001955 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001956 if (swapchain_create_info != nullptr) {
1957 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1958 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1959 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1960
1961 // Validate rest of Swapchain Image create check that require swapchain state
1962 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1963 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1964 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1965 skip |= LogError(
1966 device, vuid,
1967 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1968 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1969 }
1970 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1971 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1972 skip |= LogError(device, vuid,
1973 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1974 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1975 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08001976 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001977 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1978 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1979 skip |= LogError(device, vuid,
1980 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1981 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08001982 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001983 }
1984 }
1985 }
1986
sfricke-samsungedce77a2020-07-03 22:35:13 -07001987 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1988 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1989 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1990 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1991 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1992 }
1993 const VkImageCreateFlags invalid_flags =
1994 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1995 if ((pCreateInfo->flags & invalid_flags) != 0) {
1996 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1997 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1998 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1999 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2000 }
2001 }
2002
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002003 skip |= ValidateImageFormatFeatures(pCreateInfo);
2004
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002005 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002006 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002007 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2008 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2009 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2010 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2011 }
2012 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2013 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2014 skip |=
2015 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2016 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2017 }
2018 }
2019
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002020 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002021 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2022 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2023 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2024 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2025 "VkExternalMemoryImageCreateInfo chained structs.");
2026 }
2027 if (external_memory_create_info) {
2028 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2029 skip |= LogError(
2030 device, "VUID-VkImageCreateInfo-pNext-01443",
2031 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2032 " but pCreateInfo->initialLayout is %s.",
2033 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2034 }
2035 } else if (external_memory_create_info_nv) {
2036 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2037 skip |= LogError(
2038 device, "VUID-VkImageCreateInfo-pNext-01443",
2039 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2040 " but pCreateInfo->initialLayout is %s.",
2041 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002042 }
2043 }
2044
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002045 if (device_group_create_info.physicalDeviceCount == 1) {
2046 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2047 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2048 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2049 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2050 }
2051 }
2052
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002053 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002054}
2055
John Zulauf7eeb6f72019-06-17 11:56:36 -06002056void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2057 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2058 if (VK_SUCCESS != result) return;
2059
2060 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002061 auto image_state = Get<IMAGE_STATE>(*pImage);
2062 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002063}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002064
Jeff Bolz5c801d12019-10-09 10:38:45 -05002065bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002066 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002067 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002068 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002069 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002070 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002071 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2072 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002073 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002074 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002075 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002076 }
2077 return skip;
2078}
2079
John Zulauf7eeb6f72019-06-17 11:56:36 -06002080void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2081 // Clean up validation specific data
Jeremy Gebben6335df62021-11-01 10:50:13 -06002082 auto *image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002083 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002084
Jeremy Gebben6335df62021-11-01 10:50:13 -06002085 imageLayoutMap.erase(image_state);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002086
2087 // Clean up generic image state
2088 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002089}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002090
sfricke-samsungcd924d92020-05-20 23:51:17 -07002091bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2092 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002093 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002094 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002095 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002096
2097 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002098 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2099 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002100 }
2101
sfricke-samsungcd924d92020-05-20 23:51:17 -07002102 if (FormatIsDepthOrStencil(format)) {
2103 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2104 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2105 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2106 } else if (FormatIsCompressed(format)) {
2107 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2108 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2109 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002110 }
2111
2112 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002113 skip |=
2114 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2115 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2116 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002117 }
2118 return skip;
2119}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002120
John Zulauf07288512019-07-05 11:09:50 -06002121bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2122 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2123 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002124 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002125 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2126 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002127 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002128 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2129 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002130 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002131
2132 } else {
2133 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002134 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002135 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002136 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002137 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2138 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002139 }
2140 } else {
2141 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2142 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002143 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002144 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002145 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2146 func_name, string_VkImageLayout(dest_image_layout));
2147 }
2148 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002149 }
2150
John Zulauff660ad62019-03-23 07:16:05 -06002151 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002152 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002153 if (subresource_map) {
2154 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002155 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002156 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002157 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2158 // the next "constant value" range
2159 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002160 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002161 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2162 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2163 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2164 } else {
2165 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002166 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002167 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002168 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2169 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2170 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002171 }
John Zulauf5e617452019-11-19 14:44:16 -07002172 }
John Zulauff660ad62019-03-23 07:16:05 -06002173 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002174 }
2175
2176 return skip;
2177}
2178
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002179bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2180 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002181 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002182 bool skip = false;
2183 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002184 const auto *cb_node = GetCBState(commandBuffer);
2185 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002186 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002187 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
sfricke-samsung85584a72021-09-30 21:43:38 -07002188 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002189 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002190 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2191 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002192 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002193 skip |=
2194 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2195 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2196 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002197 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002198 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002199 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002200 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002201 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002202 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002203 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002204 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002205 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2206 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2207 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2208 string_VkFormat(image_state->createInfo.format));
2209 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002210 }
2211 return skip;
2212}
2213
John Zulaufeabb4462019-07-05 14:13:03 -06002214void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2215 const VkClearColorValue *pColor, uint32_t rangeCount,
2216 const VkImageSubresourceRange *pRanges) {
2217 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2218
2219 auto cb_node = GetCBState(commandBuffer);
2220 auto image_state = GetImageState(image);
2221 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002222 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002223 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002224 }
2225 }
2226}
2227
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002228bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2229 const char *apiName) const {
2230 bool skip = false;
2231
2232 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
sfricke-samsung45996a42021-09-16 13:45:27 -07002233 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002234 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2235 // Also VUID-VkClearDepthStencilValue-depth-00022
2236 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2237 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2238 "(=%f) is not within the [0.0, 1.0] range.",
2239 apiName, clearValue.depth);
2240 }
2241 }
2242
2243 return skip;
2244}
2245
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002246bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2247 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002248 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002249 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002250
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002251 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002252 const auto *cb_node = GetCBState(commandBuffer);
2253 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002254 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002255 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002256 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002257 "VUID-vkCmdClearDepthStencilImage-image-00010");
sfricke-samsung85584a72021-09-30 21:43:38 -07002258 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002259 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002260 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002261 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002262 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002263 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002264 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2265 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2266 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2267 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002268
2269 bool any_include_aspect_depth_bit = false;
2270 bool any_include_aspect_stencil_bit = false;
2271
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002272 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002273 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002274 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002275 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002276 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002277 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2278 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002279 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2280 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2281 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2282 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002283 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002284 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2285 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002286 if (FormatHasDepth(image_format) == false) {
2287 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2288 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2289 "doesn't have a depth component.",
2290 i, string_VkFormat(image_format));
2291 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002292 }
2293 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2294 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002295 if (FormatHasStencil(image_format) == false) {
2296 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2297 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2298 "%s doesn't have a stencil component.",
2299 i, string_VkFormat(image_format));
2300 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002301 }
2302 }
2303 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002304 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002305 if (image_stencil_struct != nullptr) {
2306 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2307 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002308 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2309 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2310 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2311 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002312 }
2313 } else {
2314 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002315 skip |= LogError(
2316 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002317 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2318 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2319 "in VkImageCreateInfo::usage used to create image");
2320 }
2321 }
2322 }
2323 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002324 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2325 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2326 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002327 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002328 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002329 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2330 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002331 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002332 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002333 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002334 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2335 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2336 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2337 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002338 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002339 }
2340 return skip;
2341}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002342
John Zulaufeabb4462019-07-05 14:13:03 -06002343void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2344 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2345 const VkImageSubresourceRange *pRanges) {
2346 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2347 auto cb_node = GetCBState(commandBuffer);
2348 auto image_state = GetImageState(image);
2349 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002350 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002351 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002352 }
2353 }
2354}
2355
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002356// Returns true if [x, xoffset] and [y, yoffset] overlap
2357static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2358 bool result = false;
2359 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2360 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2361
2362 if (intersection_max > intersection_min) {
2363 result = true;
2364 }
2365 return result;
2366}
2367
Jeff Leger178b1e52020-10-05 12:22:23 -04002368// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002369// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002370template <typename RegionType>
2371static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002372 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002373
Dave Houltonc991cc92018-03-06 11:08:51 -07002374 // Separate planes within a multiplane image cannot intersect
2375 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002376 return result;
2377 }
2378
Dave Houltonc991cc92018-03-06 11:08:51 -07002379 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2380 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2381 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002382 result = true;
2383 switch (type) {
2384 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002385 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002386 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002387 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002388 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002389 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002390 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002391 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002392 break;
2393 default:
2394 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2395 assert(false);
2396 }
2397 }
2398 return result;
2399}
2400
Dave Houltonfc1a4052017-04-27 14:32:45 -06002401// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002402static const uint32_t kXBit = 1;
2403static const uint32_t kYBit = 2;
2404static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002405static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002406 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002407 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002408 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2409 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002410 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002411 }
2412 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2413 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002414 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002415 }
2416 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2417 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002418 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002419 }
2420 return result;
2421}
2422
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002423// Test if two VkExtent3D structs are equivalent
2424static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2425 bool result = true;
2426 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2427 (extent->depth != other_extent->depth)) {
2428 result = false;
2429 }
2430 return result;
2431}
2432
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002433// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002434static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002435 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2436}
2437
2438// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002439VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002440 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2441 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002442 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002443 if (pool) {
2444 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002445 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002446 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002447 granularity.width *= block_size.width;
2448 granularity.height *= block_size.height;
2449 }
2450 }
2451 return granularity;
2452}
2453
2454// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2455static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2456 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002457 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2458 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002459 valid = false;
2460 }
2461 return valid;
2462}
2463
2464// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002465bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002466 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002467 bool skip = false;
2468 VkExtent3D offset_extent = {};
2469 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2470 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2471 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002472 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002473 // 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 -07002474 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002475 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002476 "%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 "
2477 "image transfer granularity is (w=0, h=0, d=0).",
2478 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002479 }
2480 } else {
2481 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2482 // integer multiples of the image transfer granularity.
2483 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002484 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002485 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2486 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2487 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2488 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002489 }
2490 }
2491 return skip;
2492}
2493
2494// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002495bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002496 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002497 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002499 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002500 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2501 // subresource extent.
2502 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002503 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002504 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2505 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2506 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2507 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002508 }
2509 } else {
2510 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2511 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2512 // subresource extent dimensions.
2513 VkExtent3D offset_extent_sum = {};
2514 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2515 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2516 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002517 bool x_ok = true;
2518 bool y_ok = true;
2519 bool z_ok = true;
2520 switch (image_type) {
2521 case VK_IMAGE_TYPE_3D:
2522 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2523 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002524 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002525 case VK_IMAGE_TYPE_2D:
2526 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2527 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002528 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002529 case VK_IMAGE_TYPE_1D:
2530 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2531 (subresource_extent->width == offset_extent_sum.width));
2532 break;
2533 default:
2534 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2535 assert(false);
2536 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002537 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002538 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002539 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002540 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2541 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2542 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2543 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2544 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2545 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002546 }
2547 }
2548 return skip;
2549}
2550
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002551bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002552 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002553 bool skip = false;
2554 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002555 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2556 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002557 }
2558 return skip;
2559}
2560
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002561bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002562 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002563 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002564 bool skip = false;
2565 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2566 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002567 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002568 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2569 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002570 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002571 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002572 }
2573 return skip;
2574}
2575
Jeff Leger178b1e52020-10-05 12:22:23 -04002576// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2577template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002578bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002579 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002580 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002581 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002582 VkExtent3D granularity = GetScaledItg(cb_node, img);
2583 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002584 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002585 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002586 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 return skip;
2588}
2589
Jeff Leger178b1e52020-10-05 12:22:23 -04002590// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2591template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002592bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002593 const IMAGE_STATE *dst_img, const RegionType *region,
2594 const uint32_t i, const char *function,
2595 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002596 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002597 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2598 const char *vuid;
2599
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002600 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002601 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002602 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2603 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002604 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002605 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002606 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002607 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002608 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002609
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002610 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002611 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002612 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2613 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002614 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002615 const VkExtent3D dest_effective_extent =
2616 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002617 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002618 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002619 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002620 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002621 return skip;
2622}
2623
Jeff Leger178b1e52020-10-05 12:22:23 -04002624// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2625template <typename ImageCopyRegionType>
2626bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2627 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2628 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002629 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002630 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2631 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2632 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002633
2634 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002635 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002636
2637 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002638 const VkExtent3D src_copy_extent = region.extent;
2639 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002640 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2641
Dave Houlton6f9059e2017-05-02 17:15:13 -06002642 bool slice_override = false;
2643 uint32_t depth_slices = 0;
2644
2645 // Special case for copying between a 1D/2D array and a 3D image
2646 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2647 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002648 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002649 slice_override = (depth_slices != 1);
2650 } 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 -07002651 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002652 slice_override = (depth_slices != 1);
2653 }
2654
2655 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002656 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002657 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002658 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002659 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002660 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2661 "be 0 and 1, respectively.",
2662 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002663 }
2664 }
2665
Dave Houlton533be9f2018-03-26 17:08:30 -06002666 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 -04002667 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002668 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002669 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002670 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002671 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002672 }
2673
Dave Houlton533be9f2018-03-26 17:08:30 -06002674 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002675 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002676 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 -04002677 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002678 }
2679
sfricke-samsung01da6312021-10-20 07:51:32 -07002680 // Source checks that apply only to "blocked images"
2681 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002682 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002683 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002684 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2685 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2686 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002687 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002688 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002689 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002690 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002691 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002692 }
2693
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002694 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002695 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2696 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002697 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002698 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002699 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002700 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2701 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002702 }
2703
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002704 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002705 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2706 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002707 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002708 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002709 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2710 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2711 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002712 }
2713
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002714 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002715 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2716 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002717 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002718 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002719 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2720 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2721 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002722 }
2723 } // Compressed
2724
2725 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002727 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002728 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002729 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002730 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002731 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002732 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002733 }
2734 }
2735
Dave Houlton533be9f2018-03-26 17:08:30 -06002736 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 -04002737 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002738 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002739 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2740 "and 1, respectively.",
2741 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002742 }
2743
Dave Houlton533be9f2018-03-26 17:08:30 -06002744 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002745 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002746 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 -04002747 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002748 }
2749
sfricke-samsung30b094c2020-05-30 11:42:11 -07002750 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002751 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002752 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2753 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002754 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002755 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002756 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2757 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2758 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002759 }
2760 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002761 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002762 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002763 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002764 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002765 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2766 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2767 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002768 }
2769 }
2770 } else { // Pre maint 1
2771 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002772 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002774 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002775 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002776 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2777 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002778 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002779 }
Dave Houltonee281a52017-12-08 13:51:02 -07002780 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002781 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
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] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002784 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2785 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002786 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002787 }
2788 }
2789 }
2790
sfricke-samsung01da6312021-10-20 07:51:32 -07002791 // Dest checks that apply only to "blocked images"
2792 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002793 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002794
2795 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002796 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2797 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2798 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002799 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002800 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002801 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002802 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002804 }
2805
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002806 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002807 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2808 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002809 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002810 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002811 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002812 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2813 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002814 }
2815
Dave Houltonee281a52017-12-08 13:51:02 -07002816 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2817 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2818 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002819 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002820 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002822 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2823 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002824 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002825 }
2826
Dave Houltonee281a52017-12-08 13:51:02 -07002827 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2828 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2829 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002830 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002831 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002832 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2833 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2834 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002835 }
2836 } // Compressed
2837 }
2838 return skip;
2839}
2840
Jeff Leger178b1e52020-10-05 12:22:23 -04002841template <typename RegionType>
2842bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2843 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2844 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002845 const auto *cb_node = GetCBState(commandBuffer);
2846 const auto *src_image_state = GetImageState(srcImage);
2847 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002848 const VkFormat src_format = src_image_state->createInfo.format;
2849 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002850 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002851 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002852
Jeff Leger178b1e52020-10-05 12:22:23 -04002853 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07002854 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 const char *vuid;
2856
2857 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002858
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002859 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002860
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002861 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002863
2864 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2865 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002866 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002867
Dave Houlton6f9059e2017-05-02 17:15:13 -06002868 bool slice_override = false;
2869 uint32_t depth_slices = 0;
2870
2871 // Special case for copying between a 1D/2D array and a 3D image
2872 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2873 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2874 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002875 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002876 slice_override = (depth_slices != 1);
2877 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2878 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002879 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002880 slice_override = (depth_slices != 1);
2881 }
2882
Jeff Leger178b1e52020-10-05 12:22:23 -04002883 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2884 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2885 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2886 skip |=
2887 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2888 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2889 skip |=
2890 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2891 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002892 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2894 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002895 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002896 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002897
sfricke-samsung45996a42021-09-16 13:45:27 -07002898 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002899 // No chance of mismatch if we're overriding depth slice count
2900 if (!slice_override) {
2901 // The number of depth slices in srcSubresource and dstSubresource must match
2902 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2903 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002904 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2905 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002906 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002907 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2908 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002909 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002910 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2911 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002912 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2913 "do not match.",
2914 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002915 }
2916 }
2917 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002918 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002919 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002920 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002921 skip |=
2922 LogError(command_buffer, vuid,
2923 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2924 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002925 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002926 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002927
Dave Houltonc991cc92018-03-06 11:08:51 -07002928 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002929 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002930 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2931 // If neither image is multi-plane the aspectMask member of src and dst must match
2932 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2933 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2934 skip |= LogError(command_buffer, vuid,
2935 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2936 "source (0x%x) destination (0x%x).",
2937 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2938 }
2939 } else {
2940 // Source image multiplane checks
2941 uint32_t planes = FormatPlaneCount(src_format);
2942 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2943 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2944 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2945 skip |= LogError(command_buffer, vuid,
2946 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2947 i, aspect);
2948 }
2949 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2950 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2951 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2952 skip |= LogError(command_buffer, vuid,
2953 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2954 i, aspect);
2955 }
2956 // Single-plane to multi-plane
2957 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2958 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2959 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2960 skip |= LogError(command_buffer, vuid,
2961 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2962 func_name, i, aspect);
2963 }
Dave Houltonc991cc92018-03-06 11:08:51 -07002964
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002965 // Dest image multiplane checks
2966 planes = FormatPlaneCount(dst_format);
2967 aspect = region.dstSubresource.aspectMask;
2968 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2969 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2970 skip |= LogError(command_buffer, vuid,
2971 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2972 i, aspect);
2973 }
2974 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2975 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2976 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2977 skip |= LogError(command_buffer, vuid,
2978 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2979 i, aspect);
2980 }
2981 // Multi-plane to single-plane
2982 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
2983 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2984 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2985 skip |= LogError(command_buffer, vuid,
2986 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2987 func_name, i, aspect);
2988 }
2989 }
2990 } else {
2991 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07002992 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2993 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002994 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002995 skip |= LogError(
2996 command_buffer, vuid,
2997 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
2998 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07002999 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003000 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003001
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003002 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003003 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003004 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003005 skip |=
3006 LogError(command_buffer, vuid,
3007 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3008 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003009 }
3010
3011 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003012 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003013 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003014 skip |= LogError(
3015 command_buffer, vuid,
3016 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3017 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003018 }
3019
Dave Houltonfc1a4052017-04-27 14:32:45 -06003020 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003021 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003022 if (slice_override) src_copy_extent.depth = depth_slices;
3023 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003024 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003025 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3026 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003027 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003028 "width [%1d].",
3029 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003030 }
3031
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003032 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003033 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3034 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003035 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003036 "height [%1d].",
3037 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003038 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003039 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003040 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3041 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003042 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003043 "depth [%1d].",
3044 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003045 }
3046
Dave Houltonee281a52017-12-08 13:51:02 -07003047 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003048 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003049 if (slice_override) dst_copy_extent.depth = depth_slices;
3050
3051 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003052 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003053 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3054 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003055 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003056 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003057 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003058 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003059 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003060 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3061 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003062 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003063 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003064 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003065 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003066 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003067 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3068 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003069 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003070 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003071 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003072 }
3073
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003074 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3075 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003076 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003077 for (uint32_t j = 0; j < regionCount; j++) {
3078 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003079 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003080 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003081 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003082 }
3083 }
3084 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003085
3086 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
sfricke-samsung45996a42021-09-16 13:45:27 -07003087 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003088 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3089 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3090 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003091 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3092 skip |= LogError(command_buffer, vuid,
3093 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3094 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003095 }
3096 } else {
3097 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3098 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3099 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003100 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3101 skip |= LogError(command_buffer, vuid,
3102 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3103 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003104 }
3105 }
3106
3107 // Check if 2D with 3D and depth not equal to 2D layerCount
3108 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3109 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3110 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003111 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3112 skip |= LogError(command_buffer, vuid,
3113 "%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 -08003114 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003115 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003116 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3117 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3118 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003119 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3120 skip |= LogError(command_buffer, vuid,
3121 "%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 -08003122 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003123 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003124 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003125
3126 // Check for multi-plane format compatiblity
3127 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003128 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3129 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3130 : src_format;
3131 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3132 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3133 : dst_format;
3134 const size_t src_format_size = FormatElementSize(src_plane_format);
3135 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3136
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003137 // If size is still zero, then format is invalid and will be caught in another VU
3138 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003139 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3140 skip |= LogError(command_buffer, vuid,
3141 "%s: pRegions[%u] called with non-compatible image formats. "
3142 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3143 func_name, i, string_VkFormat(src_format),
3144 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3145 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003146 }
3147 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003148 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003149
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003150 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3151 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3152 // because because both texels are 4 bytes in size.
3153 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003154 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003155 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Jeff Leger178b1e52020-10-05 12:22:23 -04003156 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3157 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003158 // Depth/stencil formats must match exactly.
3159 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3160 if (src_format != dst_format) {
3161 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003162 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003163 string_VkFormat(src_format), string_VkFormat(dst_format));
3164 }
3165 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003166 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003167 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003168 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003169 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003170 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003171 FormatElementSize(dst_format));
3172 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003173 }
3174 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003175
Dave Houlton33c22b72017-02-28 13:16:02 -07003176 // Source and dest image sample counts must match
3177 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003178 std::stringstream ss;
3179 ss << func_name << " called on image pair with non-identical sample counts.";
3180 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003181 skip |=
3182 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3183 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3184 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003185 }
3186
sfricke-samsung45996a42021-09-16 13:45:27 -07003187 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003188 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3189 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003190 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003191 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003192 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3193 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3194 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003195 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003196 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3197 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3198 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3199 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3200 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3201 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3202 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3203 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3204 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3205 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3206 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3207 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003208
3209 // Validation for VK_EXT_fragment_density_map
3210 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003211 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3212 skip |=
3213 LogError(command_buffer, vuid,
3214 "%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 +02003215 }
3216 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003217 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3218 skip |=
3219 LogError(command_buffer, vuid,
3220 "%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 +02003221 }
3222
sfricke-samsung45996a42021-09-16 13:45:27 -07003223 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003224 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3225 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3226 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3227 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003228 }
sfricke-samsung85584a72021-09-30 21:43:38 -07003229 skip |= ValidateCmd(cb_node, cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003230 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003231
3232 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003233 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003234 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3235 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3236 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003237 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003238 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3239 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3240
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003241 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003242 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003243 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003244 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3245 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003246 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003247 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003248 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003249 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003250 }
3251
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003252 return skip;
3253}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003254
Jeff Leger178b1e52020-10-05 12:22:23 -04003255bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3256 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3257 const VkImageCopy *pRegions) const {
3258 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3259 COPY_COMMAND_VERSION_1);
3260}
3261
3262bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3263 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3264 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3265 COPY_COMMAND_VERSION_2);
3266}
3267
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003268void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3269 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3270 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003271 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3272 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003273 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003274 auto src_image_state = GetImageState(srcImage);
3275 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003276
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003277 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003278 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003279 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3280 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003281 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003282}
3283
Jeff Leger178b1e52020-10-05 12:22:23 -04003284void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3285 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3286 auto cb_node = GetCBState(commandBuffer);
3287 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3288 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3289
3290 // Make sure that all image slices are updated to correct layout
3291 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003292 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3293 pCopyImageInfo->srcImageLayout);
3294 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3295 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003296 }
3297}
3298
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003299// Returns true if sub_rect is entirely contained within rect
3300static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3301 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 -07003302 (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 -07003303 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003304 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003305 return true;
3306}
3307
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003308bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003309 const IMAGE_VIEW_STATE* image_view_state,
3310 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003311 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003312
3313 for (uint32_t j = 0; j < rect_count; j++) {
3314 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003315 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003316 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3317 "the current render pass instance.",
3318 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003319 }
3320
3321 if (image_view_state) {
3322 // The layers specified by a given element of pRects must be contained within every attachment that
3323 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003324 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003325 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3326 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003327 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003328 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3329 "of pAttachment[%d].",
3330 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003331 }
3332 }
3333 }
3334 return skip;
3335}
3336
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003337bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3338 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003339 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003340 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003341 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003342 if (!cb_node) return skip;
3343
sfricke-samsung85584a72021-09-30 21:43:38 -07003344 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003345
3346 // Validate that attachment is in reference list of active subpass
3347 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003348 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003349 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003350 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003351 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003352 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003353
John Zulauf3a548ef2019-02-01 16:14:07 -07003354 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3355 auto clear_desc = &pAttachments[attachment_index];
3356 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003357 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003358
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003359 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3360 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3361 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3362 attachment_index);
3363 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3364 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3365 skip |=
3366 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3367 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3368 attachment_index);
3369 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003370 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
amhagana448ea52021-11-02 14:09:14 -04003371 if (cb_node->activeRenderPass->use_dynamic_rendering == false) {
3372 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3373 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3374 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3375 skip |= LogError(
3376 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3377 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3378 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3379 attachment_index, clear_desc->colorAttachment,
3380 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3381 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003382
amhagana448ea52021-11-02 14:09:14 -04003383 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3384 }
3385 } else {
3386 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3387 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3388 " subpass %u. colorAttachmentCount=%u",
3389 attachment_index, clear_desc->colorAttachment,
3390 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3391 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003392 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003393 }
John Zulauff2582972019-02-09 14:53:30 -07003394 fb_attachment = color_attachment;
3395
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003396 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3397 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3398 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3399 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3400 "of a color attachment.",
3401 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003402 }
3403 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003404 bool subpass_depth = false;
3405 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003406 if (subpass_desc) {
3407 if (subpass_desc->pDepthStencilAttachment &&
3408 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3409 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3410 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3411 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003412 }
amhagana448ea52021-11-02 14:09:14 -04003413 if (!subpass_desc->pDepthStencilAttachment ||
3414 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3415 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3416 skip |= LogError(
3417 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3418 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3419 "depth attachment in subpass",
3420 attachment_index);
3421 }
3422 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003423 skip |= LogError(
3424 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3425 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003426 "stencil attachment in subpass",
3427 attachment_index);
3428 }
3429 } else {
3430 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003431 }
amhagana448ea52021-11-02 14:09:14 -04003432 if (subpass_depth) {
3433 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3434 "vkCmdClearAttachments()");
3435 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003436 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003437 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003438 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003439 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3440 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3441 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3442 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003443 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003444 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003445 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003446
3447 // Once the framebuffer attachment is found, can get the image view state
3448 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3449 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3450 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003451 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003452 if (image_view_state != nullptr) {
3453 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3454 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3455 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3456 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3457 }
3458 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003459
amhagana448ea52021-11-02 14:09:14 -04003460 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3461 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3462 for (uint32_t i = 0; i < rectCount; ++i) {
3463 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3464 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3465 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3466 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3467 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3468 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003469 }
3470 }
3471 }
John Zulauf441558b2019-08-12 11:47:39 -06003472 }
3473 return skip;
3474}
3475
3476void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3477 const VkClearAttachment *pAttachments, uint32_t rectCount,
3478 const VkClearRect *pRects) {
3479 auto *cb_node = GetCBState(commandBuffer);
3480 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003481 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
amhagana448ea52021-11-02 14:09:14 -04003482 if (cb_node->activeRenderPass->use_dynamic_rendering) {
3483 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited)
3484 {
3485 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3486 const auto clear_desc = &pAttachments[attachment_index];
3487 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3488 int image_index = -1;
3489 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3490 (clear_desc->colorAttachment < colorAttachmentCount)) {
3491 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3492 }
3493 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3494 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3495 }
3496 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3497 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3498 }
3499
3500 if (image_index != -1) {
3501 if (!clear_rect_copy) {
3502 // We need a copy of the clear rectangles that will persist until the last lambda executes
3503 // but we want to create it as lazily as possible
3504 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3505 }
3506 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3507 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003508 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3509 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3510 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003511 assert(rectCount == clear_rect_copy->size());
3512 bool skip = false;
3513 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3514 if (image_index != -1) {
3515 image_view_state = (*prim_cb->active_attachments)[image_index];
3516 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003517 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3518 prim_cb->activeRenderPass->dynamic_rendering_info.renderArea,
3519 rectCount, clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003520 return skip;
3521 };
3522 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3523 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003524 }
amhagana448ea52021-11-02 14:09:14 -04003525 }
3526 }
3527 else
3528 {
3529 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3530 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003531
amhagana448ea52021-11-02 14:09:14 -04003532 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 }
3539 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3540 subpass_desc->pDepthStencilAttachment) {
3541 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3542 }
3543 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3544 if (!clear_rect_copy) {
3545 // We need a copy of the clear rectangles that will persist until the last lambda executes
3546 // but we want to create it as lazily as possible
3547 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3548 }
3549 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3550 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003551 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3552 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3553 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003554 assert(rectCount == clear_rect_copy->size());
3555 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3556 bool skip = false;
3557 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3558 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3559 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3560 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003561 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3562 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003563 return skip;
3564 };
3565 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3566 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003567 }
3568 }
3569 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003570}
3571
Jeff Leger178b1e52020-10-05 12:22:23 -04003572template <typename RegionType>
3573bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3574 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3575 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003576 const auto *cb_node = GetCBState(commandBuffer);
3577 const auto *src_image_state = GetImageState(srcImage);
3578 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003579 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003580 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE2KHR : CMD_RESOLVEIMAGE;
3581 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003582 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003583
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003584 bool skip = false;
3585 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003586 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3587 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3588 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3589 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
sfricke-samsung85584a72021-09-30 21:43:38 -07003590 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003591 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3592 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3593 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3594 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3595 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3596 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3597 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3598 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003599
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003600 // Validation for VK_EXT_fragment_density_map
3601 if (src_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: srcImage 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 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003609 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003610 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 "%s: dstImage must not have been created with flags containing "
3612 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3613 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003614 }
3615
Cort Stratton7df30962018-05-17 19:45:57 -07003616 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003617 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003618 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003619 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003620 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003621 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3623 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003624 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003625 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003626 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3627 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003628 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003629 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3630 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003631 // For each region, the number of layers in the image subresource should not be zero
3632 // For each region, src and dest image aspect must be color only
3633 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003635 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3636 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003637 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3638 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3639 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003640 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003641 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3642 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003643 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003644 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3645 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3646 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3647 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3648 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3649 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003650 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003651 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3652 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003653 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003654 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003655
3656 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003657 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003658 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3659 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003660 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003661 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003662 }
Cort Stratton7df30962018-05-17 19:45:57 -07003663 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003664 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3665 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003666 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003667 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003668 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3669 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003670 }
3671
3672 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3673 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3674
3675 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003676 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003677 LogObjectList objlist(cb_node->commandBuffer());
3678 objlist.add(src_image_state->image());
3679 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003680 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3681 skip |= LogError(objlist, vuid,
3682 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003683 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003685 }
3686 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003687 LogObjectList objlist(cb_node->commandBuffer());
3688 objlist.add(src_image_state->image());
3689 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003690 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3691 skip |= LogError(objlist, vuid,
3692 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003693 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003694 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003695 }
3696 }
3697
3698 if (VK_IMAGE_TYPE_1D == src_image_type) {
3699 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003700 LogObjectList objlist(cb_node->commandBuffer());
3701 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003702 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3703 skip |= LogError(objlist, vuid,
3704 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003705 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003706 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003707 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003708 }
3709 }
3710 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3711 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003712 LogObjectList objlist(cb_node->commandBuffer());
3713 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003714 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3715 skip |= LogError(objlist, vuid,
3716 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003717 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003718 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003719 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003720 }
3721 }
3722
3723 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3724 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003725 LogObjectList objlist(cb_node->commandBuffer());
3726 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003727 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3728 skip |= LogError(objlist, vuid,
3729 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003730 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003731 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003732 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003733 }
3734 }
3735 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3736 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003737 LogObjectList objlist(cb_node->commandBuffer());
3738 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003739 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3740 skip |= LogError(objlist, vuid,
3741 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003742 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003743 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003744 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003745 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003746 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003747
3748 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003749 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003750 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3751 // developer
3752 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3753 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003754 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003755 LogObjectList objlist(cb_node->commandBuffer());
3756 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003757 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3758 skip |= LogError(objlist, vuid,
3759 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003760 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003761 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003762 region.extent.width, subresource_extent.width);
3763 }
3764
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003765 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003766 LogObjectList objlist(cb_node->commandBuffer());
3767 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003768 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3769 skip |= LogError(objlist, vuid,
3770 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003771 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003772 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003773 region.extent.height, subresource_extent.height);
3774 }
3775
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003776 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003777 LogObjectList objlist(cb_node->commandBuffer());
3778 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003779 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3780 skip |= LogError(objlist, vuid,
3781 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003782 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003783 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003784 region.extent.depth, subresource_extent.depth);
3785 }
3786 }
3787
3788 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003789 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003790 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3791 // developer
3792 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3793 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003794 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003795 LogObjectList objlist(cb_node->commandBuffer());
3796 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003797 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3798 skip |= LogError(objlist, vuid,
3799 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003800 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003801 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003802 region.extent.width, subresource_extent.width);
3803 }
3804
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003805 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003806 LogObjectList objlist(cb_node->commandBuffer());
3807 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003808 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3809 skip |= LogError(objlist, vuid,
3810 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003811 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003812 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003813 region.extent.height, subresource_extent.height);
3814 }
3815
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003816 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003817 LogObjectList objlist(cb_node->commandBuffer());
3818 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003819 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3820 skip |= LogError(objlist, vuid,
3821 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003822 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003823 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003824 region.extent.depth, subresource_extent.depth);
3825 }
3826 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003827 }
3828
3829 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003830 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003831 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 -04003832 func_name, string_VkFormat(src_image_state->createInfo.format),
3833 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003834 }
3835 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003836 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003837 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003838 string_VkImageType(src_image_state->createInfo.imageType),
3839 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003840 }
3841 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003843 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 -07003844 }
3845 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003846 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003847 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 -04003848 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003849 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003850 } else {
3851 assert(0);
3852 }
3853 return skip;
3854}
3855
Jeff Leger178b1e52020-10-05 12:22:23 -04003856bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3857 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3858 const VkImageResolve *pRegions) const {
3859 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3860 COPY_COMMAND_VERSION_1);
3861}
3862
3863bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3864 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3865 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3866 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3867 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3868}
3869
3870template <typename RegionType>
3871bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3872 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3873 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003874 const auto *cb_node = GetCBState(commandBuffer);
3875 const auto *src_image_state = GetImageState(srcImage);
3876 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003877
Jeff Leger178b1e52020-10-05 12:22:23 -04003878 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003879 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE2KHR : CMD_BLITIMAGE;
3880 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003881
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003882 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003883 if (cb_node) {
sfricke-samsung85584a72021-09-30 21:43:38 -07003884 skip |= ValidateCmd(cb_node, cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07003885 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003886 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003887 const char *vuid;
3888 const char *location;
3889 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3890 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3891 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3892 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3893 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3894 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3895 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3896 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3897 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3898 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3899 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3900 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3901 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3902 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3903 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3904 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07003905 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3907 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3908 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3909 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3910 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3911 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3912 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3913 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3914 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3915 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003916
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003917 // Validation for VK_EXT_fragment_density_map
3918 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003919 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003920 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003921 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3922 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003923 }
3924 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003925 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003926 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003927 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3928 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003929 }
3930
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003931 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003932
Dave Houlton33c2d252017-06-09 17:08:32 -06003933 VkFormat src_format = src_image_state->createInfo.format;
3934 VkFormat dst_format = dst_image_state->createInfo.format;
3935 VkImageType src_type = src_image_state->createInfo.imageType;
3936 VkImageType dst_type = dst_image_state->createInfo.imageType;
3937
Cort Stratton186b1a22018-05-01 20:18:06 -04003938 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003939 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3940 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3941 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003942 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003943 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003944 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003945 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003946 }
3947
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003948 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003949 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04003950 skip |= LogError(device, vuid,
3951 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003952 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003953 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003954 }
3955
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003956 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003957 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04003958 skip |= LogError(device, vuid,
3959 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003960 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003961 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003962 }
3963
ziga-lunarg52604a12021-09-09 16:02:05 +02003964 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003965 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003966 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02003967 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003968 }
3969
Dave Houlton33c2d252017-06-09 17:08:32 -06003970 // Validate consistency for unsigned formats
3971 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3972 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003973 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003974 << "the other one must also have unsigned integer format. "
3975 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003976 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003977 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003978 }
3979
3980 // Validate consistency for signed formats
3981 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3982 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003983 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003984 << "the other one must also have signed integer format. "
3985 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003986 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003987 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003988 }
3989
3990 // Validate filter for Depth/Stencil formats
3991 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3992 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003993 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003994 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003995 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003996 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003997 }
3998
3999 // Validate aspect bits and formats for depth/stencil images
4000 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4001 if (src_format != dst_format) {
4002 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004003 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 -06004004 << "stencil, the other one must have exactly the same format. "
4005 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4006 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004007 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004008 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004009 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004010 } // Depth or Stencil
4011
4012 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004013 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004014 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004015 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4016 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004017 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4019 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004020 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004021 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4023 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004024 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004025 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4026 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004027 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004028 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004029 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004030 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004031 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004032 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4033 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004034 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004035 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4036 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4037 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4038 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4039 skip |=
4040 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4041 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4042 skip |=
4043 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4044 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004045 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004046 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4047 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004048 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004049 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004050 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004051 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4052 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004053 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004054 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004055 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004056 }
Dave Houlton48989f32017-05-26 15:01:46 -06004057 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4058 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004059 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004060 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004061 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004062 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004063
4064 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004065 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004066 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4067 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004068 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004069 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004070 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004071
Dave Houlton48989f32017-05-26 15:01:46 -06004072 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004073 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4074 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004075 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004076 }
Dave Houlton48989f32017-05-26 15:01:46 -06004077
Dave Houlton33c2d252017-06-09 17:08:32 -06004078 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004079 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004080 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004081 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004082 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004083 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004084 }
4085
4086 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004087 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004088 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004089 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4090 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004091 }
4092
Dave Houlton48989f32017-05-26 15:01:46 -06004093 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004094 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004095 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004096 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004097 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004098 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004099 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4100 "of (%1d, %1d). These must be (0, 1).",
4101 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004102 }
4103 }
4104
Dave Houlton33c2d252017-06-09 17:08:32 -06004105 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004106 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004107 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004108 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004109 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4110 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4111 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004112 }
4113 }
4114
Dave Houlton33c2d252017-06-09 17:08:32 -06004115 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004116 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4117 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004118 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004119 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004120 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004121 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4122 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004123 }
4124 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4125 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004126 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004127 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004128 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004129 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4130 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004131 }
4132 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4133 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004134 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004135 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004136 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004137 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4138 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004139 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004140 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004141 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004142 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004143 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004144 }
Dave Houlton48989f32017-05-26 15:01:46 -06004145
4146 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004147 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004148 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004149 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004150 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004151 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004152 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4153 "(%1d, %1d). These must be (0, 1).",
4154 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004155 }
4156 }
4157
Dave Houlton33c2d252017-06-09 17:08:32 -06004158 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004159 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004160 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004161 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004162 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004163 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004164 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004165 }
4166 }
4167
Dave Houlton33c2d252017-06-09 17:08:32 -06004168 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004169 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4170 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004171 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004172 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004173 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004174 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4175 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004176 }
4177 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4178 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004179 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004180 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004181 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004182 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4183 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004184 }
4185 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4186 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004187 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004188 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004189 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004190 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4191 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004192 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004193 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004194 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004195 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004196 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004197 }
4198
Dave Houlton33c2d252017-06-09 17:08:32 -06004199 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4200 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4201 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004202 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004203 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004204 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4205 "layerCount other than 1.",
4206 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004207 }
4208 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004209 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004210 } else {
4211 assert(0);
4212 }
4213 return skip;
4214}
4215
Jeff Leger178b1e52020-10-05 12:22:23 -04004216bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4217 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4218 const VkImageBlit *pRegions, VkFilter filter) const {
4219 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4220 COPY_COMMAND_VERSION_1);
4221}
4222
4223bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4224 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4225 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4226 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4227}
4228
4229template <typename RegionType>
4230void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4231 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4232 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004233 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004234 auto src_image_state = GetImageState(srcImage);
4235 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004236
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004237 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004238 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004239 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4240 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004241 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004242}
4243
Jeff Leger178b1e52020-10-05 12:22:23 -04004244void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4245 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4246 const VkImageBlit *pRegions, VkFilter filter) {
4247 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4248 pRegions, filter);
4249 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4250}
4251
4252void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4253 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4254 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4255 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4256 pBlitImageInfo->filter);
4257}
4258
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004259GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004260 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004261 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004262 if (!layout_map) {
4263 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004264 }
John Zulauf17708d02021-02-22 11:20:58 -07004265 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004266}
4267
Jeremy Gebben6335df62021-11-01 10:50:13 -06004268const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4269 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004270 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004271 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004272 }
4273 return nullptr;
4274}
4275
Jeremy Gebben53631302021-04-13 16:46:37 -06004276// Helper to update the Global or Overlay layout map
4277struct GlobalLayoutUpdater {
4278 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4279 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4280 dst = src.current_layout;
4281 return true;
4282 }
4283 return false;
4284 }
4285
4286 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4287 layer_data::optional<VkImageLayout> result;
4288 if (src.current_layout != image_layout_map::kInvalidLayout) {
4289 result.emplace(src.current_layout);
4290 }
4291 return result;
4292 }
4293};
4294
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004295// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004296bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
4297 const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004298 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004299 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004300 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004301 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004302 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004303 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004304 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004305 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004306 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004307 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004308 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004309
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004310 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben6335df62021-11-01 10:50:13 -06004311 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004312 if (global_map == nullptr) {
4313 global_map = &empty_map;
4314 }
4315
4316 // Note: don't know if it would matter
4317 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4318
Jeremy Gebben53631302021-04-13 16:46:37 -06004319 auto pos = layout_map.begin();
4320 const auto end = layout_map.end();
4321 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4322 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004323 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004324 VkImageLayout initial_layout = pos->second.initial_layout;
4325 assert(initial_layout != image_layout_map::kInvalidLayout);
4326 if (initial_layout == image_layout_map::kInvalidLayout) {
4327 continue;
4328 }
4329
John Zulauf2076e812020-01-08 14:55:54 -07004330 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004331
John Zulauf2076e812020-01-08 14:55:54 -07004332 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 -07004333 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004334 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004335 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004336 image_layout = current_layout->pos_B->lower_bound->second;
4337 }
4338 const auto intersected_range = pos->first & current_layout->range;
4339 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4340 // TODO: Set memory invalid which is in mem_tracker currently
4341 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004342 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4343 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004344 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004345 // We can report all the errors for the intersected range directly
4346 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004347 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004348 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004349 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004350 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004351 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004352 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004353 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004354 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004355 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004356 }
4357 }
John Zulauf2076e812020-01-08 14:55:54 -07004358 if (pos->first.includes(intersected_range.end)) {
4359 current_layout.seek(intersected_range.end);
4360 } else {
4361 ++pos;
4362 if (pos != end) {
4363 current_layout.seek(pos->first.begin);
4364 }
4365 }
John Zulauff660ad62019-03-23 07:16:05 -06004366 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004367 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004368 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004369 }
John Zulauff660ad62019-03-23 07:16:05 -06004370
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004371 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004372}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004373
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004374void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004375 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004376 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004377 const auto &subres_map = layout_map_entry.second;
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004378 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004379 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004380 }
4381}
4382
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004383// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004384// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4385// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004386bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4387 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004388 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004389 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004390 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4391
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004392 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004393 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4394 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004395 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004396 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4397 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4398 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004399 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004400 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004401 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004402 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004403 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4404 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004405 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004406 string_VkImageLayout(first_layout));
4407 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4408 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004409 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004410 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004411 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004412 }
4413 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004414
4415 // Same as above for loadOp, but for stencilLoadOp
4416 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4417 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4418 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4419 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4420 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004421 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004422 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004423 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004424 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4425 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004426 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004427 string_VkImageLayout(first_layout));
4428 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4429 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4430 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004431 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004432 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004433 }
4434 }
4435
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004436 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004437}
4438
Mark Lobodzinski96210742017-02-09 10:33:46 -07004439// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4440// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004441template <typename T1>
4442bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4443 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4444 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004445 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004446 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004447 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004448 if (strict) {
4449 correct_usage = ((actual & desired) == desired);
4450 } else {
4451 correct_usage = ((actual & desired) != 0);
4452 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004453
Mark Lobodzinski96210742017-02-09 10:33:46 -07004454 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004455 // All callers should have a valid VUID
4456 assert(msgCode != kVUIDUndefined);
4457 skip =
4458 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4459 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004460 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004461 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004462}
4463
4464// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4465// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004466bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004467 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004468 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004469 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004470}
4471
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004472bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004473 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004474 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004475 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4476 if ((image_format_features & desired) != desired) {
4477 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004478 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004479 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004480 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4481 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4482 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004483 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004484 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004485 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004486 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4487 "with tiling %s.",
4488 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004489 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004490 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004491 }
4492 }
4493 return skip;
4494}
4495
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004496bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004497 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004498 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004499 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004500 // layerCount must not be zero
4501 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004502 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004503 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004504 }
4505 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004506 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004507 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004508 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004509 }
4510 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004511 if ((apsect_mask & VK_IMAGE_ASPECT_COLOR_BIT) && (apsect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004512 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004513 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4514 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4515 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004516 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004517 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4518 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4519 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004520 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004521 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4522 member);
4523 }
Cort Strattond619a302018-05-17 19:46:32 -07004524 return skip;
4525}
4526
Mark Lobodzinski96210742017-02-09 10:33:46 -07004527// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4528// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004529bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004530 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004531 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004532 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004533}
4534
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004535bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004536 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004537 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004538
4539 const VkDeviceSize &range = pCreateInfo->range;
4540 if (range != VK_WHOLE_SIZE) {
4541 // Range must be greater than 0
4542 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004543 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004544 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004545 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4546 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004547 }
4548 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004549 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4550 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004551 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004552 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004553 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4554 "(%" PRIu32 ").",
4555 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004556 }
4557 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004558 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004559 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004560 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004561 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4562 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4563 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004564 }
4565 // The sum of range and offset must be less than or equal to the size of buffer
4566 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004567 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004568 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004569 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4570 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4571 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004572 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004573 } else {
4574 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4575
4576 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4577 // VkPhysicalDeviceLimits::maxTexelBufferElements
4578 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4579 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004580 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004581 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4582 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4583 "), divided by the element size of the format (%" PRIu32
4584 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4585 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4586 device_limits->maxTexelBufferElements);
4587 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004588 }
4589 return skip;
4590}
4591
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004592bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004593 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004594 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004595 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4596 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004597 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004598 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004599 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4600 "be supported for uniform texel buffers",
4601 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004602 }
4603 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4604 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004605 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004606 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004607 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4608 "be supported for storage texel buffers",
4609 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004610 }
4611 return skip;
4612}
4613
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004614bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004615 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004616 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004617
Dave Houltond8ed0212018-05-16 17:18:24 -06004618 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004619
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004620 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004621 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004622 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004623 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004624 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4625 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004626 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004627 }
4628 }
4629
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004630 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004631 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004632 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004633 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004634 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004635 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4636 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004637 }
4638 }
4639
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004640 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4641 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4642 if (pCreateInfo->flags &
4643 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4644 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4645 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4646 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4647 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4648 }
4649 }
4650
Mike Schuchardt2df08912020-12-15 16:28:09 -08004651 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004652 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004653 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004654 skip |= LogError(
4655 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004656 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004657 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004658 }
4659
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004660 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004661 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4662 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4663 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004664 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004665 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004666 }
4667
sfricke-samsungedce77a2020-07-03 22:35:13 -07004668 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4669 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4670 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4671 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4672 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4673 }
4674 const VkBufferCreateFlags invalid_flags =
4675 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4676 if ((pCreateInfo->flags & invalid_flags) != 0) {
4677 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4678 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4679 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4680 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4681 }
4682 }
4683
Mark Lobodzinski96210742017-02-09 10:33:46 -07004684 return skip;
4685}
4686
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004687bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004688 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004689 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004690 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004691
4692 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4693 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4694 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4695 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4696 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4697 "defined sizes for alignment, replace with a color format.",
4698 string_VkFormat(pCreateInfo->format));
4699 }
4700
Mark Lobodzinski96210742017-02-09 10:33:46 -07004701 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4702 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004703 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004704 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4705 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004706 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004707 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4708 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4709 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004710
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004711 // Buffer view offset must be less than the size of buffer
4712 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004713 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004714 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004715 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4716 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004717 }
4718
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004719 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004720 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4721 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4722 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004723 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4724 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4725 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004726 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004727 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004728 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4729 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004730 }
4731
4732 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004733 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4734 if ((element_size % 3) == 0) {
4735 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004736 }
4737 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004738 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004739 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4740 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004741 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004742 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004743 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004744 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004745 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004746 "vkCreateBufferView(): If buffer was created with usage containing "
4747 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004748 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4749 ") must be a multiple of the lesser of "
4750 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4751 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4752 "(%" PRId32
4753 ") is VK_TRUE, the size of a texel of the requested format. "
4754 "If the size of a texel is a multiple of three bytes, then the size of a "
4755 "single component of format is used instead",
4756 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4757 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4758 }
4759 }
4760 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004761 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004762 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4763 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004764 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004765 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004766 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004768 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004769 "vkCreateBufferView(): If buffer was created with usage containing "
4770 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004771 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4772 ") must be a multiple of the lesser of "
4773 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4774 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4775 "(%" PRId32
4776 ") is VK_TRUE, the size of a texel of the requested format. "
4777 "If the size of a texel is a multiple of three bytes, then the size of a "
4778 "single component of format is used instead",
4779 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4780 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4781 }
4782 }
4783 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004784
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004785 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004786
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004787 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004788 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004789 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004790}
4791
Mark Lobodzinski602de982017-02-09 11:01:33 -07004792// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004793bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004794 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004795 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004796 const IMAGE_STATE *image_state = GetImageState(image);
4797 // checks color format and (single-plane or non-disjoint)
4798 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004799 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004800 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004801 skip |= LogError(
4802 image, vuid,
4803 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4804 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004805 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004806 skip |= LogError(image, vuid,
4807 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4808 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4809 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004810 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004811 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004812 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004813 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004814 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4815 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4816 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004817 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004818 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004819 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4820 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4821 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004822 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004823 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004824 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004825 skip |= LogError(image, vuid,
4826 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4827 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4828 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004829 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004830 skip |= LogError(image, vuid,
4831 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4832 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4833 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004834 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004835 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004836 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004837 skip |= LogError(image, vuid,
4838 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4839 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4840 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004841 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004842 skip |= LogError(image, vuid,
4843 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4844 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4845 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004846 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004847 } else if (FormatIsMultiplane(format)) {
4848 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4849 if (3 == FormatPlaneCount(format)) {
4850 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4851 }
4852 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004853 skip |= LogError(image, vuid,
4854 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4855 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4856 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004857 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004858 }
4859 return skip;
4860}
4861
ziga-lunarg04e94b32021-10-03 01:42:37 +02004862bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
4863 bool skip = false;
4864
ziga-lunarg04e94b32021-10-03 01:42:37 +02004865 return skip;
4866}
4867
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004868bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4869 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004870 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004871 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004872 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004873
4874 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004875 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004876 skip |= LogError(image, errorCodes.base_mip_err,
4877 "%s: %s.baseMipLevel (= %" PRIu32
4878 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4879 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004880 }
Petr Kraus4d718682017-05-18 03:38:41 +02004881
Petr Krausffa94af2017-08-08 21:46:02 +02004882 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4883 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004884 skip |=
4885 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004886 } else {
4887 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004888
Petr Krausffa94af2017-08-08 21:46:02 +02004889 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004890 skip |= LogError(image, errorCodes.mip_count_err,
4891 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4892 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4893 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4894 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004895 }
Petr Kraus4d718682017-05-18 03:38:41 +02004896 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004897 }
Petr Kraus4d718682017-05-18 03:38:41 +02004898
4899 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004900 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004901 skip |= LogError(image, errorCodes.base_layer_err,
4902 "%s: %s.baseArrayLayer (= %" PRIu32
4903 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4904 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004905 }
Petr Kraus4d718682017-05-18 03:38:41 +02004906
Petr Krausffa94af2017-08-08 21:46:02 +02004907 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4908 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004909 skip |=
4910 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004911 } else {
4912 const uint64_t necessary_layer_count =
4913 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004914
Petr Krausffa94af2017-08-08 21:46:02 +02004915 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004916 skip |= LogError(image, errorCodes.layer_count_err,
4917 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4918 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4919 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4920 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004921 }
Petr Kraus4d718682017-05-18 03:38:41 +02004922 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004923 }
Petr Kraus4d718682017-05-18 03:38:41 +02004924
ziga-lunargb4e90752021-08-02 13:58:29 +02004925 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4926 if (subresourceRange.aspectMask &
4927 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4928 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4929 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4930 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4931 cmd_name);
4932 }
4933 }
4934
Mark Lobodzinski602de982017-02-09 11:01:33 -07004935 return skip;
4936}
4937
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004938bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004939 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004940 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004941 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004942 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004943 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 +02004944
David McFarland2853f2f2020-11-30 15:50:39 -04004945 uint32_t image_layer_count;
4946
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004947 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004948 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004949 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004950 image_layer_count = extent.depth;
4951 } else {
4952 image_layer_count = image_state->createInfo.arrayLayers;
4953 }
4954
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004955 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004956
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004957 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4958 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4959 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4960 subresource_range_error_codes.base_layer_err =
4961 is_khr_maintenance1
4962 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4963 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4964 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4965 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4966 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4967 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004968
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004969 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004970 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004971 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004972}
4973
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004974bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004975 const VkImageSubresourceRange &subresourceRange,
4976 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004977 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4978 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4979 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4980 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4981 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004982
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004983 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004984 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004985 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004986}
4987
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004988bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004989 const VkImageSubresourceRange &subresourceRange,
4990 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004991 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4992 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4993 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4994 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4995 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004996
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004997 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004998 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004999 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005000}
5001
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005002bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005003 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005004 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005005 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005006 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005007}
5008
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005009namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005010using sync_vuid_maps::GetBarrierQueueVUID;
5011using sync_vuid_maps::kQueueErrorSummary;
5012using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005013
5014class ValidatorState {
5015 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005016 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005017 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5018 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005019 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005020 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005021 barrier_handle_(barrier_handle),
5022 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005023 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5024 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5025
5026 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5027 // 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 -07005028 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5029 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005030 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005031 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5032 loc_.Message().c_str(), GetTypeString(),
5033 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5034 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005035 }
5036
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005037 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5038 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005039 const char *src_annotation = GetFamilyAnnotation(src_family);
5040 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5041 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005042 objects_, val_code,
5043 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5044 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5045 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005046 }
5047
5048 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5049 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5050 // application input.
5051 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5052 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005053 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005054 uint32_t queue_family = queue_state->queueFamilyIndex;
5055 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005056 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005057 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5058 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5059 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005060 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005061 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005062 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005063 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005064 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005065 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005066 }
5067 return false;
5068 }
5069 // Logical helpers for semantic clarity
5070 inline bool KhrExternalMem() const { return mem_ext_; }
5071 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5072 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5073 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5074 }
5075
5076 // Helpers for LogMsg
5077 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5078
5079 // Descriptive text for the various types of queue family index
5080 const char *GetFamilyAnnotation(uint32_t family) const {
5081 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5082 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5083 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5084 const char *valid = " (VALID)";
5085 const char *invalid = " (INVALID)";
5086 switch (family) {
5087 case VK_QUEUE_FAMILY_EXTERNAL:
5088 return external;
5089 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5090 return foreign;
5091 case VK_QUEUE_FAMILY_IGNORED:
5092 return ignored;
5093 default:
5094 if (IsValid(family)) {
5095 return valid;
5096 }
5097 return invalid;
5098 };
5099 }
5100 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5101 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5102
5103 protected:
5104 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005105 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005106 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005107 const VulkanTypedHandle barrier_handle_;
5108 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005109 const uint32_t limit_;
5110 const bool mem_ext_;
5111};
5112
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005113bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005114 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5115 bool skip = false;
5116
5117 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5118 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5119 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5120 if (val.KhrExternalMem()) {
5121 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005122 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5123 // this requirement is removed by VK_KHR_synchronization2
5124 if (!(src_ignored || dst_ignored) && !sync2) {
5125 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005126 }
5127 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5128 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005129 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005130 }
5131 } else {
5132 // VK_SHARING_MODE_EXCLUSIVE
5133 if (src_queue_family != dst_queue_family) {
5134 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005135 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005136 }
5137 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005138 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005139 }
5140 }
5141 }
5142 } else {
5143 // No memory extension
5144 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005145 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5146 // this requirement is removed by VK_KHR_synchronization2
5147 if ((!src_ignored || !dst_ignored) && !sync2) {
5148 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005149 }
5150 } else {
5151 // VK_SHARING_MODE_EXCLUSIVE
5152 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005153 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005154 }
5155 }
5156 }
5157 return skip;
5158}
5159} // namespace barrier_queue_families
5160
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005161bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005162 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005163 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5164 uint32_t dst_queue_family) {
5165 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005166 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005167 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5168}
5169
5170// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005171template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005172bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5173 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005174 // State data is required
5175 if (!state_data) {
5176 return false;
5177 }
5178
5179 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005180 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005181 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005182 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5183 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005184 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005185}
5186
5187// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005188template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005189bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5190 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005191 // State data is required
5192 if (!state_data) {
5193 return false;
5194 }
5195
5196 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005197 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005198 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005199 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5200 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005201 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5202}
5203
5204template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005205bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005206 const Barrier &mem_barrier) const {
5207 using sync_vuid_maps::BufferError;
5208 using sync_vuid_maps::GetBufferBarrierVUID;
5209
5210 bool skip = false;
5211
5212 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5213
5214 // Validate buffer barrier queue family indices
5215 auto buffer_state = GetBufferState(mem_barrier.buffer);
5216 if (buffer_state) {
5217 auto buf_loc = loc.dot(Field::buffer);
5218 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005219 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005220
5221 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5222
5223 auto buffer_size = buffer_state->createInfo.size;
5224 if (mem_barrier.offset >= buffer_size) {
5225 auto offset_loc = loc.dot(Field::offset);
5226 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5227
5228 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5229 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5230 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5231 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5232 auto size_loc = loc.dot(Field::size);
5233 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5234 skip |= LogError(objects, vuid,
5235 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5236 ".",
5237 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5238 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5239 }
5240 if (mem_barrier.size == 0) {
5241 auto size_loc = loc.dot(Field::size);
5242 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5243 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5244 report_data->FormatHandle(mem_barrier.buffer).c_str());
5245 }
5246 }
5247 return skip;
5248}
5249
5250template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005251bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005252 const Barrier &mem_barrier) const {
5253 bool skip = false;
5254
5255 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5256
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005257 bool is_ilt = true;
5258 if (enabled_features.synchronization2_features.synchronization2) {
5259 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5260 }
5261
5262 if (is_ilt) {
5263 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5264 auto layout_loc = loc.dot(Field::newLayout);
5265 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5266 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005267 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005268 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005269 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005270 }
5271
5272 auto image_data = GetImageState(mem_barrier.image);
5273 if (image_data) {
5274 auto image_loc = loc.dot(Field::image);
5275
John Zulaufbea70432021-02-23 07:03:12 -07005276 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005277
5278 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5279
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005280 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005281 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005282
5283 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
ziga-lunarg04e94b32021-10-03 01:42:37 +02005284 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005285 }
5286 return skip;
5287}
5288
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005289bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5290 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5291 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005292 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5293 const VkImageMemoryBarrier *pImageMemBarriers) const {
5294 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005295 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005296
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005297 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5298 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005299 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005300 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005301 }
5302 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5303 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005304 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005305 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005306 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5307 }
5308 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005309 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005310 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5311 }
5312 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5313 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005314 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005315 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005316 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5317 }
5318 return skip;
5319}
5320
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005321bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005322 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005323 bool skip = false;
5324
5325 if (cb_state->activeRenderPass) {
5326 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5327 if (skip) return true; // Early return to avoid redundant errors from below calls
5328 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005329 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5330 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005331 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005332 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005333 }
5334 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5335 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005336 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005337 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005338 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5339 }
5340 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005341 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005342 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5343 }
5344
5345 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5346 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005347 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005348 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005349 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5350 }
5351
5352 return skip;
5353}
5354
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005355// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005356template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005357bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5358 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005359 VkPipelineStageFlags dst_stage_mask) const {
5360 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005361 assert(cb_state);
5362 auto queue_flags = cb_state->GetQueueFlags();
5363
5364 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005365 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5366 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005367 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005368 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5369 }
5370 return skip;
5371}
5372
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005373// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005374template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005375bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5376 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005377 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005378 assert(cb_state);
5379 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005380
Jeremy Gebbenefead332021-06-18 08:22:44 -06005381 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005382 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005383 skip |=
5384 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5385 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005386
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005387 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005388 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005389 skip |=
5390 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5391 }
5392 return skip;
5393}
5394
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005395// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5396// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5397// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5398static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5399 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5400}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005401
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005402bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5403 const VkSubpassDependency2 &dependency) const {
5404 bool skip = false;
5405 Location loc = in_loc;
5406 VkMemoryBarrier2KHR converted_barrier;
5407 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5408
5409 if (mem_barrier && enabled_features.synchronization2_features.synchronization2) {
5410 if (dependency.srcAccessMask != 0) {
5411 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5412 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5413 loc.dot(Field::srcAccessMask).Message().c_str());
5414 }
5415 if (dependency.dstAccessMask != 0) {
5416 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5417 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5418 loc.dot(Field::dstAccessMask).Message().c_str());
5419 }
5420 if (dependency.srcStageMask != 0) {
5421 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5422 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5423 loc.dot(Field::srcStageMask).Message().c_str());
5424 }
5425 if (dependency.dstStageMask != 0) {
5426 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5427 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5428 loc.dot(Field::dstStageMask).Message().c_str());
5429 }
5430 loc = in_loc.dot(Field::pNext);
5431 converted_barrier = *mem_barrier;
5432 } else {
5433 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005434 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5435 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5436 loc.Message().c_str());
5437 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005438 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5439 converted_barrier.srcStageMask = dependency.srcStageMask;
5440 converted_barrier.dstStageMask = dependency.dstStageMask;
5441 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5442 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005443 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005444 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5445 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5446 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5447 converted_barrier.srcStageMask);
5448
5449 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5450 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5451 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5452 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005453 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005454}
5455
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005456bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5457 const VkImageUsageFlags image_usage) const {
5458 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5459 bool skip = false;
5460
5461 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5462 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5463
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005464 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005465 // AHB image view and image share same feature sets
5466 tiling_features = image_state->format_features;
5467 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5468 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005469 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005470 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5471 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005472 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005473
5474 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5475 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5476 nullptr};
5477 format_properties_2.pNext = (void *)&drm_properties_list;
5478 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5479
nyorain38a9d232021-03-06 13:06:12 +01005480 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5481 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5482 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5483
5484 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5485
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005486 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5487 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5488 0) {
5489 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5490 }
5491 }
5492 } else {
5493 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5494 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5495 : format_properties.optimalTilingFeatures;
5496 }
5497
5498 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005499 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005500 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5501 "physical device.",
5502 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5503 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005504 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005505 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5506 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5507 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5508 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005509 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005510 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5511 "VK_IMAGE_USAGE_STORAGE_BIT.",
5512 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5513 } 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 -06005514 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005515 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5516 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5517 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5518 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5519 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005520 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005521 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5522 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5523 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5524 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5525 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005526 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005527 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5528 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5529 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005530 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5531 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5532 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005533 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005534 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5535 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5536 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5537 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005538 }
5539
5540 return skip;
5541}
5542
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005543bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005544 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005545 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005546 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005547 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005548 skip |=
5549 ValidateImageUsageFlags(image_state,
5550 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5551 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005552 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5553 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5554 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005555 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005556 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005557 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005558 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005559 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005560 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005561 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005562 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005563
5564 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5565 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005566 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005567 VkFormat view_format = pCreateInfo->format;
5568 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005569 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005570 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005571 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005572
Dave Houltonbd2e2622018-04-10 16:41:14 -06005573 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005574 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005575 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005576 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5577 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005578 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005579 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5580 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5581 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005582 }
5583 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005584 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005585 if (image_stencil_struct == nullptr) {
5586 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005587 skip |= LogError(
5588 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005589 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5590 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5591 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5592 }
5593 } else {
5594 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5595 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5596 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005597 skip |= LogError(
5598 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005599 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5600 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5601 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5602 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5603 }
5604 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5605 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005606 skip |= LogError(
5607 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005608 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5609 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5610 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5611 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5612 }
5613 }
5614 }
5615 }
5616
Dave Houltonbd2e2622018-04-10 16:41:14 -06005617 image_usage = chained_ivuci_struct->usage;
5618 }
5619
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005620 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5621 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5622 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5623 bool foundFormat = false;
5624 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5625 if (format_list_info->pViewFormats[i] == view_format) {
5626 foundFormat = true;
5627 break;
5628 }
5629 }
5630 if (foundFormat == false) {
5631 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5632 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5633 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5634 string_VkFormat(view_format));
5635 }
5636 }
5637
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005638 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5639 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005640 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005641 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005642 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005643 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005644 std::stringstream ss;
5645 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005646 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005647 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005648 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005649 }
5650 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005651 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005652 // 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 -07005653 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5654 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5655 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5656 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005657 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005658 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5659 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005660 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005661 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5662 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005663 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005664 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5665 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005666 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5667 } else {
5668 // both enabled
5669 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5670 }
Dave Houltonc7988072018-04-16 11:46:56 -06005671 std::stringstream ss;
5672 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005673 << " is not in the same format compatibility class as "
5674 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005675 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5676 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005677 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005678 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005679 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005680 }
5681 } else {
5682 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005683 // Unless it is a multi-planar color bit aspect
5684 if ((image_format != view_format) &&
5685 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005686 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5687 ? "VUID-VkImageViewCreateInfo-image-01762"
5688 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005689 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005690 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005691 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005692 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005693 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005694 }
5695 }
5696
ziga-lunargebb32de2021-08-29 21:24:30 +02005697 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5698 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5699 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5700 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5701 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5702 }
5703
Mark Lobodzinski602de982017-02-09 11:01:33 -07005704 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005705 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005706
sfricke-samsung20a8a372021-07-14 06:12:17 -07005707 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005708 switch (image_type) {
5709 case VK_IMAGE_TYPE_1D:
5710 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005711 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5712 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5713 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005714 }
5715 break;
5716 case VK_IMAGE_TYPE_2D:
5717 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5718 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5719 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005720 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5721 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5722 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005723 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005724 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5725 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5726 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005727 }
5728 }
5729 break;
5730 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005731 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005732 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5733 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005734 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005735 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005736 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005737 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5738 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005739 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005740 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5741 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005742 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005743 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005744 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5745 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5746 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5747 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005748 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5749 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5750 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5751 "levelCount of 1 but it is %u.",
5752 string_VkImageViewType(view_type), string_VkImageType(image_type),
5753 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005754 }
5755 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005756 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5757 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5758 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005759 }
5760 }
5761 } else {
5762 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005763 // Help point to VK_KHR_maintenance1
5764 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5765 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5766 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5767 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5768 string_VkImageViewType(view_type), string_VkImageType(image_type));
5769 } else {
5770 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5771 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5772 string_VkImageViewType(view_type), string_VkImageType(image_type));
5773 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005774 }
5775 }
5776 break;
5777 default:
5778 break;
5779 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005780
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005781 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005782 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005783 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005784 }
5785
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005786 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005787
sfricke-samsung828e59d2021-08-22 23:20:49 -07005788 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005789 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5790 if (view_format != VK_FORMAT_R8_UINT) {
5791 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5792 "vkCreateImageView() If image was created with usage containing "
5793 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5794 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005795 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005796 }
5797
sfricke-samsung828e59d2021-08-22 23:20:49 -07005798 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00005799 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5800 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5801 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5802 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5803 "vkCreateImageView() If image was created with usage containing "
5804 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5805 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5806 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005807 }
5808 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005809
Tobias Hector6663c9b2020-11-05 10:18:02 +00005810 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5811 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005812 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005813 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5814 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005815 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005816 }
5817
sfricke-samsung20a8a372021-07-14 06:12:17 -07005818 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5819 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5820 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005821 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5822 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005823 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005824 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005825 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005826 skip |= LogError(
5827 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5828 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005829 remaining_layers);
5830 }
5831 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5832 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5833 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5834 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5835 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5836 string_VkImageViewType(view_type), remaining_layers);
5837 }
5838 } else {
5839 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5840 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5841 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5842 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5843 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5844 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005845 }
5846 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005847
5848 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5849 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005850 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005851 "vkCreateImageView(): If image was created with usage containing "
5852 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5853 pCreateInfo->subresourceRange.levelCount);
5854 }
5855 }
5856 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5857 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005858 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005859 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5860 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5861 }
5862 } else {
5863 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5864 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5865 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005866 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005867 "vkCreateImageView(): If image was created with usage containing "
5868 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5869 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5870 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5871 }
5872 }
5873 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005874
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005875 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5876 if (pCreateInfo->subresourceRange.levelCount != 1) {
5877 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5878 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5879 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5880 pCreateInfo->subresourceRange.levelCount);
5881 }
5882 if (pCreateInfo->subresourceRange.layerCount != 1) {
5883 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5884 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5885 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5886 pCreateInfo->subresourceRange.layerCount);
5887 }
5888 }
5889
Nathaniel Cesario42d5b282021-08-17 12:47:24 -06005890 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(view_format) &&
ziga-lunargc290c7f2021-07-31 22:01:46 +02005891 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5892 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5893 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5894 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5895 string_VkFormat(image_format));
5896 }
5897
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005898 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5899 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5900 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5901 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5902 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5903 }
5904 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5905 skip |=
5906 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5907 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5908 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5909 }
5910 }
sfricke-samsung45996a42021-09-16 13:45:27 -07005911 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005912 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005913 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005914 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5915 "vkCreateImageView(): If image was created with flags containing "
5916 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5917 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005918 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005919 }
5920 }
5921
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005922 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07005923 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005924 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5925 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5926 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5927 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5928 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5929 }
5930 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005931
sfricke-samsung45996a42021-09-16 13:45:27 -07005932 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005933 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005934 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5935 // VK_COMPONENT_SWIZZLE_IDENTITY."
5936 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5937 // also be defined via R, G, B, A enums in the correct order.
5938 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005939 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005940 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005941 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5942 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5943 }
5944
5945 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5946 // disabled
5947 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5948 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5949 // spec. See Github issue #2361.
5950 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5951 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5952 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07005953 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005954 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5955 "vkCreateImageView (portability error): ImageView format must have"
5956 " the same number of components and bits per component as the Image's format");
5957 }
5958 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005959 }
5960 return skip;
5961}
5962
Jeff Leger178b1e52020-10-05 12:22:23 -04005963template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005964bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005965 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005966 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005967 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5968 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5969 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005970
5971 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5972 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5973 VkDeviceSize src_min = UINT64_MAX;
5974 VkDeviceSize src_max = 0;
5975 VkDeviceSize dst_min = UINT64_MAX;
5976 VkDeviceSize dst_max = 0;
5977
5978 for (uint32_t i = 0; i < regionCount; i++) {
5979 src_min = std::min(src_min, pRegions[i].srcOffset);
5980 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5981 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5982 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5983
5984 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5985 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005986 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005987 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02005988 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
5989 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
5990 func_name, i, pRegions[i].srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005991 }
5992
5993 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5994 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005995 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005996 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02005997 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
5998 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
5999 func_name, i, pRegions[i].dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006000 }
6001
6002 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6003 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006004 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006005 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006006 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006007 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006008 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006009 }
6010
6011 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6012 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006013 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006014 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006015 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006016 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006017 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006018 }
6019 }
6020
6021 // 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 -06006022 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006023 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006024 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006025 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04006026 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006027 }
6028 }
6029
6030 return skip;
6031}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006032template <typename RegionType>
6033bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
6034 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006035 const auto cb_node = GetCBState(commandBuffer);
6036 const auto src_buffer_state = GetBufferState(srcBuffer);
6037 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006038
sfricke-samsung11813ab2021-10-20 14:53:37 -07006039 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6040 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFER2KHR : CMD_COPYBUFFER;
6041 const char *func_name = CommandTypeString(cmd_type);
6042 const char *vuid;
6043
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006044 bool skip = false;
sfricke-samsung11813ab2021-10-20 14:53:37 -07006045 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
6046 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6047 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
6048 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
6049
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006050 // Validate that SRC & DST buffers have correct usage flags set
sfricke-samsung11813ab2021-10-20 14:53:37 -07006051 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
6052 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
6053 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6054 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
6055 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
6056 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6057
6058 skip |= ValidateCmd(cb_node, cmd_type);
6059 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, version);
6060
6061 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
6062 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6063 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
6064 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6065 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
6066 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006067 return skip;
6068}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006069
sfricke-samsung11813ab2021-10-20 14:53:37 -07006070bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6071 uint32_t regionCount, const VkBufferCopy *pRegions) const {
6072 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, COPY_COMMAND_VERSION_1);
6073}
6074
Jeff Leger178b1e52020-10-05 12:22:23 -04006075bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6076 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006077 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6078 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006079}
6080
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006081bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006082 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006083 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006084 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006085 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006086 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6087 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006088 }
6089 }
6090 return skip;
6091}
6092
Jeff Bolz5c801d12019-10-09 10:38:45 -05006093bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6094 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006095 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006096
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006097 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006098 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006099 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006100 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006101 }
6102 return skip;
6103}
6104
Jeff Bolz5c801d12019-10-09 10:38:45 -05006105bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006106 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006107
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006108 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006109 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006110 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006111 }
6112 return skip;
6113}
6114
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006115void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6116 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6117 if (buffer_state) {
6118 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
6119 if (itr != buffer_address_map_.end()) {
6120 buffer_address_map_.erase(itr);
6121 }
6122 }
6123 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6124}
6125
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006126bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006127 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006128 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006129 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006130 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006131 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006132 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006133 }
6134 return skip;
6135}
6136
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006137bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006138 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006139 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006140 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006141 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006142 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
sfricke-samsung85584a72021-09-30 21:43:38 -07006143 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006144 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006145 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6146 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006147
sfricke-samsung022fa252020-07-24 03:26:16 -07006148 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6149 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6150
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006151 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006152 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6153 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6154 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6155 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006156 }
6157
6158 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006159 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6160 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6161 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6162 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006163 }
6164
sfricke-samsung45996a42021-09-16 13:45:27 -07006165 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006166 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6167 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6168 }
6169
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006170 return skip;
6171}
6172
Jeff Leger178b1e52020-10-05 12:22:23 -04006173template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006174bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006175 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006176 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006177 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006178 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6179 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006180
sfricke-samsung125d2b42020-05-28 06:32:43 -07006181 assert(image_state != nullptr);
6182 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006183
6184 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006185 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006186 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6187 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006188 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006189 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6190 "and 1, respectively.",
6191 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006192 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006193 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006194
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006195 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6196 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006197 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006198 "%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 -07006199 "must be 0 and 1, respectively.",
6200 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006201 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006202 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006203
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006204 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6205 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006206 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006207 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006208 "For 3D images these must be 0 and 1, respectively.",
6209 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006210 }
6211 }
6212
6213 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006214 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006215 const uint32_t element_size =
6216 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006217 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006218
sfricke-samsung8feecc12021-01-23 03:28:38 -08006219 if (FormatIsDepthOrStencil(image_format)) {
6220 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006221 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006222 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6223 " must be a multiple 4 if using a depth/stencil format (%s).",
6224 function, i, bufferOffset, string_VkFormat(image_format));
6225 }
6226 } else {
6227 // If not depth/stencil and not multi-plane
6228 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006229 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
sfricke-samsung8feecc12021-01-23 03:28:38 -08006230 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6231 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006232 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006233 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6234 " must be a multiple of this format's texel size (%" PRIu32 ").",
6235 function, i, bufferOffset, element_size);
6236 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006237 }
6238
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006239 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6240 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006241 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006242 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006243 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006244 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006245 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006246 }
6247
6248 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6249 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006250 vuid =
6251 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006252 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006253 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006254 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6255 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006256 }
6257
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006258 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006259 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006260 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006261 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 -06006262 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6263 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006264 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006265 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006266 "zero or <= image subresource width (%d).",
6267 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006268 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006269 }
6270
6271 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006272 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 -06006273 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6274 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006275 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006276 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006277 "zero or <= image subresource height (%d).",
6278 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006279 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006280 }
6281
6282 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006283 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 -06006284 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6285 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006286 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006287 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006288 "zero or <= image subresource depth (%d).",
6289 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006290 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006291 }
6292
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006293 // subresource aspectMask must have exactly 1 bit set
6294 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006295 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006296 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006297 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006298 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006299 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006300 }
6301
6302 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006303 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006304 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006305 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006306 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6307 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006308 }
6309
6310 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006311 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006312 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006313
6314 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006315 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006316 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
6317 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
6318 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006319 }
6320
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006321 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006322 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006323 skip |=
6324 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
6325 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
6326 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006327 }
6328
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006329 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006330 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6331 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6332 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006333 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006334 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006335 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006336 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6337 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006338 }
6339
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006340 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006341 if (SafeModulo(bufferOffset, element_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006342 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006343 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006344 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006345 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006346 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006347
6348 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006349 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006350 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006351 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006352 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006353 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006354 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006355 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6356 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006357 }
6358
6359 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006360 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006361 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006362 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006363 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006364 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006365 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6366 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006367 }
6368
6369 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006370 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006371 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006372 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006373 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006374 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006375 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6376 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006377 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006378 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006379
6380 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006381 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006382 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006383 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006384 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006385 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006386 "format has three planes.",
6387 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006388 }
6389
6390 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006391 if (0 ==
6392 (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 -06006393 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006394 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006395 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6396 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006397 } else {
6398 // Know aspect mask is valid
6399 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6400 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006401 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006402 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006403 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006404 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006405 " 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 -08006406 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006407 string_VkFormat(compatible_format));
6408 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006409 }
6410 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006411
6412 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006413 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006414 assert(command_pool != nullptr);
6415 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6416 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6417 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006418 LogObjectList objlist(cb_node->commandBuffer());
6419 objlist.add(command_pool->commandPool());
6420 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006421 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6422 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6423 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6424 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006425 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6426 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006427 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006428 }
6429
6430 return skip;
6431}
6432
Jeff Leger178b1e52020-10-05 12:22:23 -04006433template <typename BufferImageCopyRegionType>
6434bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6435 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006436 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006437 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006438
6439 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006440 VkExtent3D extent = pRegions[i].imageExtent;
6441 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006442
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006443 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6444 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006445 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006446 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6447 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006448 }
6449
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006450 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006451
sfricke-samsung01da6312021-10-20 07:51:32 -07006452 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6453 // vkspec.html#_common_operation)
6454 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006455 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006456 if (image_extent.width % block_extent.width) {
6457 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6458 }
6459 if (image_extent.height % block_extent.height) {
6460 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6461 }
6462 if (image_extent.depth % block_extent.depth) {
6463 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6464 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006465 }
6466
Dave Houltonfc1a4052017-04-27 14:32:45 -06006467 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006468 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006469 }
6470 }
6471
6472 return skip;
6473}
6474
Jeff Leger178b1e52020-10-05 12:22:23 -04006475template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006476bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006477 const BufferImageCopyRegionType *pRegions, const char *func_name,
6478 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006479 bool skip = false;
6480
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006481 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006482
6483 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006484 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format);
6485 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6486 if (buffer_copy_size != 0) {
6487 const VkDeviceSize max_buffer_copy = buffer_copy_size + pRegions[i].bufferOffset;
6488 if (buffer_size < max_buffer_copy) {
6489 skip |= LogError(device, msg_code,
6490 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6491 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
6492 func_name, i, buffer_copy_size, pRegions[i].bufferOffset,
6493 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6494 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006495 }
6496 }
6497
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006498 return skip;
6499}
6500
Jeff Leger178b1e52020-10-05 12:22:23 -04006501template <typename BufferImageCopyRegionType>
6502bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6503 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6504 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006505 const auto cb_node = GetCBState(commandBuffer);
6506 const auto src_image_state = GetImageState(srcImage);
6507 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006508
Jeff Leger178b1e52020-10-05 12:22:23 -04006509 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006510 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
sfricke-samsung85584a72021-09-30 21:43:38 -07006511 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006512 const char *vuid;
6513
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006514 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006515
6516 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006517 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006518
6519 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006520 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006521
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006522 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006523
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006524 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006525 vuid =
6526 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6527 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6528 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6529 "or transfer capabilities.",
6530 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006531 }
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006532 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeff Leger178b1e52020-10-05 12:22:23 -04006533 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6534 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6535 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006536
Jeff Leger178b1e52020-10-05 12:22:23 -04006537 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6538 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6539 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6540
6541 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6542 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6543 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6544 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006545
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006546 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006547 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6548 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006549 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006550 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6551 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006552 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006553 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6554 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6555 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6556 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6557 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6558 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006559
6560 // Validation for VK_EXT_fragment_density_map
6561 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006562 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006563 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006564 "%s: srcImage must not have been created with flags containing "
6565 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6566 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006567 }
6568
sfricke-samsung45996a42021-09-16 13:45:27 -07006569 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006570 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6571 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006572 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006573 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006574
sfricke-samsung45996a42021-09-16 13:45:27 -07006575 const char *src_invalid_layout_vuid =
6576 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6577 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6578 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6579 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6580 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006581
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006582 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006583 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6584 vuid =
6585 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006586 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006587 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6588 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6589 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6590 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6591 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6592 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6593 "imageSubresource", vuid);
6594 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6595 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006596 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006597 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006598 }
6599 return skip;
6600}
6601
Jeff Leger178b1e52020-10-05 12:22:23 -04006602bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6603 VkBuffer dstBuffer, uint32_t regionCount,
6604 const VkBufferImageCopy *pRegions) const {
6605 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6606 COPY_COMMAND_VERSION_1);
6607}
6608
6609bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6610 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6611 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6612 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6613 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6614}
6615
John Zulauf1686f232019-07-09 16:27:11 -06006616void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6617 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6618 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6619
6620 auto cb_node = GetCBState(commandBuffer);
6621 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006622 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006623 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006624 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006625 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006626}
6627
Jeff Leger178b1e52020-10-05 12:22:23 -04006628void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6629 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6630 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6631
6632 auto cb_node = GetCBState(commandBuffer);
6633 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6634 // Make sure that all image slices record referenced layout
6635 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006636 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6637 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006638 }
6639}
6640
6641template <typename RegionType>
6642bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6643 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6644 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006645 const auto cb_node = GetCBState(commandBuffer);
6646 const auto src_buffer_state = GetBufferState(srcBuffer);
6647 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006648
Jeff Leger178b1e52020-10-05 12:22:23 -04006649 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006650 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07006651 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006652 const char *vuid;
6653
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006654 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006655
6656 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006657 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006658
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006659 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeff Leger178b1e52020-10-05 12:22:23 -04006660 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6661 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6662 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6663
6664 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6665 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6666 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6667 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6668 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6669 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6670 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6671 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6672 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006673 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006674 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6675 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006676 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006677 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6678 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6679 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6680 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6681 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6682 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006683
6684 // Validation for VK_EXT_fragment_density_map
6685 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006686 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006687 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006688 "%s: dstImage must not have been created with flags containing "
6689 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6690 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006691 }
6692
sfricke-samsung45996a42021-09-16 13:45:27 -07006693 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006694 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6695 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006696 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006697 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006698
sfricke-samsung45996a42021-09-16 13:45:27 -07006699 const char *dst_invalid_layout_vuid =
6700 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6701 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6702 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6703 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6704 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006705
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006706 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006707 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6708 vuid =
6709 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006710 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006711 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6712 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6713 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6714 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6715 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6716 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6717 "imageSubresource", vuid);
6718 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6719 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006720 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006721 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006722
6723 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006724 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07006725 assert(command_pool != nullptr);
6726 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6727 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6728 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6729 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6730 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006731 LogObjectList objlist(cb_node->commandBuffer());
6732 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006733 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6734 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006735 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006736 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6737 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6738 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006739 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6740 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006741 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006742 }
6743 return skip;
6744}
6745
Jeff Leger178b1e52020-10-05 12:22:23 -04006746bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6747 VkImageLayout dstImageLayout, uint32_t regionCount,
6748 const VkBufferImageCopy *pRegions) const {
6749 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6750 COPY_COMMAND_VERSION_1);
6751}
6752
6753bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6754 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6755 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6756 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6757 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6758}
6759
John Zulauf1686f232019-07-09 16:27:11 -06006760void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6761 VkImageLayout dstImageLayout, uint32_t regionCount,
6762 const VkBufferImageCopy *pRegions) {
6763 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6764
6765 auto cb_node = GetCBState(commandBuffer);
6766 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006767 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006768 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006769 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006770 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006771}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006772
Jeff Leger178b1e52020-10-05 12:22:23 -04006773void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6774 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6775 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6776
6777 auto cb_node = GetCBState(commandBuffer);
6778 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6779 // Make sure that all image slices are record referenced layout
6780 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006781 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6782 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006783 }
6784}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006785bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006786 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006787 bool skip = false;
6788 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6789
Dave Houlton1d960ff2018-01-19 12:17:05 -07006790 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006791 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6792 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6793 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006794 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6795 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006796 }
6797
John Zulaufa26d3c82019-08-14 16:09:08 -06006798 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006799 if (!image_entry) {
6800 return skip;
6801 }
6802
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006803 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07006804 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006805 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6806 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006807 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6808 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6809 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006810 }
6811 } else {
6812 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006813 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6814 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006815 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006816 }
6817
Dave Houlton1d960ff2018-01-19 12:17:05 -07006818 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006819 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006820 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6821 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6822 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006823 }
6824
Dave Houlton1d960ff2018-01-19 12:17:05 -07006825 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006826 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006827 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6828 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6829 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006830 }
6831
Dave Houlton1d960ff2018-01-19 12:17:05 -07006832 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006833 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006834 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6835 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006836 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006837 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6838 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006839 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006840 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6841 }
6842 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006843 skip |= LogError(image, vuid,
6844 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6845 ") must be a single-plane specifier flag.",
6846 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006847 }
6848 } else if (FormatIsColor(img_format)) {
6849 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02006850 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006851 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6852 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006853 }
6854 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006855 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006856 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006857 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02006858 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
6859 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
6860 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6861 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
6862 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
6863 string_VkFormat(img_format));
6864 }
6865 } else {
6866 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
6867 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
6868 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
6869 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
6870 string_VkFormat(img_format));
6871 }
6872 }
6873 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
6874 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
6875 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6876 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
6877 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
6878 string_VkFormat(img_format));
6879 }
6880 } else {
6881 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
6882 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
6883 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
6884 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
6885 string_VkFormat(img_format));
6886 }
6887 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006888 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6889 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6890 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6891 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006892 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6893 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6894 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006895 }
6896 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006897
sfricke-samsung45996a42021-09-16 13:45:27 -07006898 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006899 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006900 }
6901
Mike Weiblen672b58b2017-02-21 14:32:53 -07006902 return skip;
6903}
sfricke-samsung022fa252020-07-24 03:26:16 -07006904
6905// Validates the image is allowed to be protected
6906bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006907 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006908 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006909
6910 // if driver supports protectedNoFault the operation is valid, just has undefined values
6911 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006912 LogObjectList objlist(cb_state->commandBuffer());
6913 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006914 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 -06006915 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6916 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006917 }
6918 return skip;
6919}
6920
6921// Validates the image is allowed to be unprotected
6922bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006923 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006924 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006925
6926 // if driver supports protectedNoFault the operation is valid, just has undefined values
6927 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006928 LogObjectList objlist(cb_state->commandBuffer());
6929 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006930 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 -06006931 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6932 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006933 }
6934 return skip;
6935}
6936
6937// Validates the buffer is allowed to be protected
6938bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006939 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006940 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006941
6942 // if driver supports protectedNoFault the operation is valid, just has undefined values
6943 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006944 LogObjectList objlist(cb_state->commandBuffer());
6945 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006946 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 -06006947 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6948 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006949 }
6950 return skip;
6951}
6952
6953// Validates the buffer is allowed to be unprotected
6954bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006955 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006956 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006957
6958 // if driver supports protectedNoFault the operation is valid, just has undefined values
6959 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006960 LogObjectList objlist(cb_state->commandBuffer());
6961 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006962 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 -06006963 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6964 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006965 }
6966 return skip;
6967}