blob: 49966f7b39dc63764872dabf9e237d6af90e2ffa [file] [log] [blame]
Jeremy Gebben65975ed2021-10-29 11:16:10 -06001/* Copyright (c) 2015-2022 The Khronos Group Inc.
2 * Copyright (c) 2015-2022 Valve Corporation
3 * Copyright (c) 2015-2022 LunarG, Inc.
4 * Copyright (C) 2015-2022 Google Inc.
Aaron Hagan1656b2b2021-12-21 11:52:41 -05005 * Modifications Copyright (C) 2020-2022 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 Gebben4a8881f2022-01-10 17:04:30 -0700337 const auto *layout_range_map = image_state.layout_range_map.get();
John Zulauf2076e812020-01-08 14:55:54 -0700338 if (!layout_range_map) return false;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700339
340 auto guard = layout_range_map->ReadLock();
locke-lunargf155ccf2020-02-18 11:34:15 -0700341 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
342 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
343
John Zulauf2076e812020-01-08 14:55:54 -0700344 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
345
346 // 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 -0700347 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700348 return false;
349 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700350
John Zulauf79f06582021-02-27 18:38:39 -0700351 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700352 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700353 }
354 return true;
355}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700356
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700357bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600358 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700359 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600360 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600362 const auto &image_view = image_view_state.Handle();
363 const auto *image_state = image_view_state.image_state.get();
364 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100365 const char *vuid;
366 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700367 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100368
369 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600370 LogObjectList objlist(image);
371 objlist.add(renderpass);
372 objlist.add(framebuffer);
373 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700374 skip |=
375 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
376 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
377 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
378 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100379 return skip;
380 }
381
382 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700383 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200384 if (stencil_usage_info) {
385 image_usage |= stencil_usage_info->stencilUsage;
386 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100387
388 // Check for layouts that mismatch image usages in the framebuffer
389 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800390 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600391 LogObjectList objlist(image);
392 objlist.add(renderpass);
393 objlist.add(framebuffer);
394 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700395 skip |= LogError(objlist, vuid,
396 "%s: Layout/usage mismatch for attachment %u in %s"
397 " - the %s is %s but the image attached to %s via %s"
398 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
399 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
400 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
401 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100402 }
403
404 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
405 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800406 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600407 LogObjectList objlist(image);
408 objlist.add(renderpass);
409 objlist.add(framebuffer);
410 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700411 skip |= LogError(objlist, vuid,
412 "%s: Layout/usage mismatch for attachment %u in %s"
413 " - the %s is %s but the image attached to %s via %s"
414 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
415 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
416 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
417 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100418 }
419
420 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800421 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600422 LogObjectList objlist(image);
423 objlist.add(renderpass);
424 objlist.add(framebuffer);
425 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700426 skip |= LogError(objlist, vuid,
427 "%s: Layout/usage mismatch for attachment %u in %s"
428 " - the %s is %s but the image attached to %s via %s"
429 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
430 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
431 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
432 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100433 }
434
435 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800436 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600437 LogObjectList objlist(image);
438 objlist.add(renderpass);
439 objlist.add(framebuffer);
440 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700441 skip |= LogError(objlist, vuid,
442 "%s: Layout/usage mismatch for attachment %u in %s"
443 " - the %s is %s but the image attached to %s via %s"
444 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
445 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
446 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
447 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100448 }
449
sfricke-samsung45996a42021-09-16 13:45:27 -0700450 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
452 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
453 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
454 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
455 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800456 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600457 LogObjectList objlist(image);
458 objlist.add(renderpass);
459 objlist.add(framebuffer);
460 objlist.add(image_view);
461 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700462 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700463 " - the %s is %s but the image attached to %s via %s"
464 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700465 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700466 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
467 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100468 }
469 } else {
470 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
471 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
472 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
473 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600474 LogObjectList objlist(image);
475 objlist.add(renderpass);
476 objlist.add(framebuffer);
477 objlist.add(image_view);
478 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700479 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700480 " - the %s is %s but the image attached to %s via %s"
481 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700482 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700483 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
484 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485 }
486 }
487 return skip;
488}
489
John Zulauf17a01bb2019-08-09 16:41:19 -0600490bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700491 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600492 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600493 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600494 const auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
495 const auto *render_pass_info = render_pass_state->createInfo.ptr();
496 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700497 auto const &framebuffer_info = framebuffer_state->createInfo;
498 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100499
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600500 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100501
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700502 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600503 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700504 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700505 }
John Zulauf8e308292018-09-21 11:34:37 -0600506
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700507 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800508 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700509 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100510 }
511
Tobias Hectorc9057422019-07-23 12:15:52 +0100512 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700513 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
514 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100515 auto image_view = attachments[i];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600516 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100517
Tobias Hectorc9057422019-07-23 12:15:52 +0100518 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600519 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600520 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600521 objlist.add(image_view);
522 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700523 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600524 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700525 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100526 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100527 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100528
529 const VkImage image = view_state->create_info.image;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600530 const auto *image_state = view_state->image_state.get();
Tobias Hectorc9057422019-07-23 12:15:52 +0100531
532 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600533 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600534 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600535 objlist.add(image_view);
536 objlist.add(image);
537 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700538 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600539 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700540 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100541 continue;
542 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700543 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
544 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100545
Piers Daniell7f894f62020-01-09 16:33:48 -0700546 // Default to expecting stencil in the same layout.
547 auto attachment_stencil_initial_layout = attachment_initial_layout;
548
549 // If a separate layout is specified, look for that.
550 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700551 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700552 if (attachment_description_stencil_layout) {
553 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
554 }
555
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200556 const ImageSubresourceLayoutMap *subresource_map = nullptr;
557 bool has_queried_map = false;
558 bool subres_skip = false;
Tobias Hectorc9057422019-07-23 12:15:52 +0100559
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200560 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
561 VkImageAspectFlags test_aspect = 1u << aspect_index;
562 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
563 continue;
564 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700565
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200566 // Allow for differing depth and stencil layouts
567 VkImageLayout check_layout = attachment_initial_layout;
568 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
569 check_layout = attachment_stencil_initial_layout;
570 }
571
572 if (check_layout != VK_IMAGE_LAYOUT_UNDEFINED) { // If no layout information for image yet, will be checked at QueueSubmit time
573 if (!has_queried_map) {
574 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
575 // in common with the non-const version.)
576 // The lookup is expensive, so cache it.
Jeremy Gebben6335df62021-11-01 10:50:13 -0600577 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200578 has_queried_map = true;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200579 }
John Zulauf5e617452019-11-19 14:44:16 -0700580
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200581 if (subresource_map) {
582 auto normalized_range = view_state->normalized_subresource_range;
583 normalized_range.aspectMask = test_aspect;
584 auto pos = subresource_map->Find(normalized_range);
585 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200586
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200587 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
588 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
589 const VkImageSubresource &subres = pos->subresource;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200590
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200591 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
592 subres_skip |= LogError(
593 device, kVUID_Core_DrawState_InvalidRenderpass,
594 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
595 "and the %s layout of the attachment is %s. The layouts must match, or the render "
596 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
597 i, string_VkImageLayout(check_layout), layout_check.message,
598 string_VkImageLayout(layout_check.layout));
599 }
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200600 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100601 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700602 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100603 }
604
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200605 skip |= subres_skip;
606
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600607 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state, framebuffer,
608 render_pass, i, "initial layout");
Tobias Hectorc9057422019-07-23 12:15:52 +0100609
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600610 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer, render_pass, i,
611 "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100612 }
613
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700614 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
615 auto &subpass = render_pass_info->pSubpasses[j];
616 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100617 auto &attachment_ref = subpass.pInputAttachments[k];
618 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
619 auto image_view = attachments[attachment_ref.attachment];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600620 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100621
Tobias Hectorc9057422019-07-23 12:15:52 +0100622 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600623 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700624 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100625 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100626 }
627 }
628 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100629
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700630 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100631 auto &attachment_ref = subpass.pColorAttachments[k];
632 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
633 auto image_view = attachments[attachment_ref.attachment];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600634 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100635
Tobias Hectorc9057422019-07-23 12:15:52 +0100636 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600637 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Tobias Hectorc9057422019-07-23 12:15:52 +0100638 framebuffer, render_pass, attachment_ref.attachment,
639 "color attachment layout");
640 if (subpass.pResolveAttachments) {
641 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600642 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
643 "resolve attachment layout");
Tobias Hectorc9057422019-07-23 12:15:52 +0100644 }
645 }
646 }
647 }
648
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700649 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100650 auto &attachment_ref = *subpass.pDepthStencilAttachment;
651 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
652 auto image_view = attachments[attachment_ref.attachment];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600653 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorc9057422019-07-23 12:15:52 +0100654
655 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600656 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Tobias Hectorc9057422019-07-23 12:15:52 +0100657 framebuffer, render_pass, attachment_ref.attachment,
658 "input attachment layout");
659 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100660 }
661 }
662 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700663 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600664 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700665}
666
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600667void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700668 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700669 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600670 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600671 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700672 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700673 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700674 if (attachment_reference_stencil_layout) {
675 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
676 }
677
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600678 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600679 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700680 }
681}
682
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600683void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
684 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700685 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700686
687 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700688 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700689 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700690 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700691 }
692 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700693 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700694 }
695 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700696 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700697 }
698 }
699}
700
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700701// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
702// 1. Transition into initialLayout state
703// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600704void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700705 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700706 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700707 auto const rpci = render_pass_state->createInfo.ptr();
708 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600709 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600710 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700711 IMAGE_STATE *image_state = view_state->image_state.get();
712 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700713 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700714 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700715 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700716 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
717 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
718 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600719 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700720 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600721 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700722 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600723 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700724 }
John Zulauf8e308292018-09-21 11:34:37 -0600725 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700726 }
727 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700728 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700729}
730
Dave Houlton10b39482017-03-16 13:18:15 -0600731bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600732 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600733 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600734 }
735 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600736 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600737 }
738 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600739 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600740 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800741 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 -0700742 if (FormatPlaneCount(format) == 1) return false;
743 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600744 return true;
745}
746
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700747// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
748// but some features/extensions can explicitly turn that restriction off
749// The implicit check is done in format utils, while feature checks are done here in CoreChecks
750bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
751 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
752 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
753 return false;
754 }
755 return FormatRequiresYcbcrConversion(format);
756}
757
Mike Weiblen62d08a32017-03-07 22:18:27 -0700758// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700759bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700760 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700762 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700763 switch (layout) {
764 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700765 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700766 break;
767 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_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_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700771 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700772 break;
773 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700774 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700775 break;
776 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700777 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 break;
779 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700780 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700781 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600782 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700783 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500784 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700785 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_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;
788 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700789 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700790 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700791 default:
792 // Other VkImageLayout values do not have VUs defined in this context.
793 break;
794 }
795
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700796 if (is_error) {
797 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
798
799 skip |=
800 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
801 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700802 }
803 return skip;
804}
805
806// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700807template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700808bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700809 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700810 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700811 using sync_vuid_maps::GetImageBarrierVUID;
812 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200813
John Zulauf463c51e2018-05-31 13:29:20 -0600814 // Scoreboard for duplicate layout transition barriers within the list
815 // 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 +0200816 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
817 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600818
Mike Weiblen62d08a32017-03-07 22:18:27 -0700819 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700820 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200821 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700822
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600823 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600824 if (image_state) {
825 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700826 skip |=
827 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
828 skip |=
829 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600830
831 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
832 if (image_state->layout_locked) {
833 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700834 skip |= LogError(
835 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700836 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600837 " 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 -0700838 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
839 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600840 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600841
John Zulaufa4472282019-08-22 14:44:34 -0600842 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700843 const VkFormat image_format = image_create_info.format;
844 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600845 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700846 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700847 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700848 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600849 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700850 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
851 skip |= LogError(img_barrier.image, vuid,
852 "%s references %s of format %s that must have either the depth or stencil "
853 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
854 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
855 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600856 }
857 } else {
858 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
859 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700860 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700861 ? ImageError::kNotSeparateDepthAndStencilAspect
862 : ImageError::kNotDepthAndStencilAspect;
863 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700864 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700865 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700866 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700867 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700868 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600869 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700870 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700871 }
John Zulauff660ad62019-03-23 07:16:05 -0600872
Petr Krausad0096a2019-08-09 18:35:04 +0200873 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600874 // TODO: Set memory invalid which is in mem_tracker currently
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200875 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -0600876 auto &write_subresource_map = layout_updates[image_state.get()];
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200877 bool new_write = false;
878 if (!write_subresource_map) {
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700879 write_subresource_map = std::make_shared<ImageSubresourceLayoutMap>(*image_state);
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200880 new_write = true;
881 }
Jeremy Gebben9f537102021-10-05 16:37:12 -0600882 const auto &current_subresource_map = current_map.find(image_state.get());
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200883 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
884 ? (*current_subresource_map).second
885 : write_subresource_map;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200886
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200887 bool subres_skip = false;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200888 // Validate aspects in isolation.
889 // This is required when handling separate depth-stencil layouts.
890 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
891 VkImageAspectFlags test_aspect = 1u << aspect_index;
892 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
893 continue;
894 }
895
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700896 LayoutUseCheckAndMessage layout_check(read_subresource_map.get(), test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200897 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
898 normalized_isr.aspectMask = test_aspect;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200899 // 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 +0200900 for (auto pos = read_subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip;
901 pos.IncrementInterval()) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200902 const auto &value = *pos;
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200903 auto old_layout = NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200904 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
905 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
906 subres_skip =
907 LogError(cb_state->commandBuffer(), vuid,
908 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
909 "%s layout is %s.",
910 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
911 value.subresource.aspectMask, value.subresource.mipLevel, value.subresource.arrayLayer,
912 string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
913 string_VkImageLayout(layout_check.layout));
914 }
John Zulauff660ad62019-03-23 07:16:05 -0600915 }
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200916 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
John Zulauf5e617452019-11-19 14:44:16 -0700917 }
John Zulauff660ad62019-03-23 07:16:05 -0600918 skip |= subres_skip;
919 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700920
921 // checks color format and (single-plane or non-disjoint)
922 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
923 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700924 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700925 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700926 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
927 : ImageError::kNotColorAspectYcbcr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700928 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -0700929 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700930 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -0700931 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700932 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700933 string_VkFormat(image_format), aspect_mask);
934 }
935 }
936
937 VkImageAspectFlags valid_disjoint_mask =
938 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 -0700939 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700940 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700941 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
942 skip |= LogError(img_barrier.image, vuid,
943 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -0700944 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700945 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700946 string_VkFormat(image_format), aspect_mask);
947 }
948
949 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700950 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
951 skip |= LogError(img_barrier.image, vuid,
952 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -0700953 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700954 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700955 string_VkFormat(image_format), aspect_mask);
956 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700957 }
958 }
959 return skip;
960}
961
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700962template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700963bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700964 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700966 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -0600967 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700968 if (!IsTransferOp(barrier)) {
969 return skip;
970 }
971 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600972 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700973 const auto found = barrier_sets.release.find(barrier);
974 if (found != barrier_sets.release.cend()) {
975 barrier_record = &(*found);
976 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -0600977 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600978 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700979 const auto found = barrier_sets.acquire.find(barrier);
980 if (found != barrier_sets.acquire.cend()) {
981 barrier_record = &(*found);
982 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -0600983 }
984 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700985 if (barrier_record != nullptr) {
986 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600987 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700988 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
989 " duplicates existing barrier recorded in this command buffer.",
990 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
991 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
992 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600993 return skip;
994}
995
John Zulaufa4472282019-08-22 14:44:34 -0600996VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
997 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
998}
999
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001000VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1001 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1002}
1003
Jeremy Gebben9f537102021-10-05 16:37:12 -06001004std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1005 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001006 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001007}
1008
Jeremy Gebben9f537102021-10-05 16:37:12 -06001009std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1010 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001011 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001012}
1013
John Zulaufa4472282019-08-22 14:44:34 -06001014VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1015 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1016}
1017
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001018VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1019 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1020}
1021
Jeremy Gebben9f537102021-10-05 16:37:12 -06001022const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1023 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001024 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001025}
1026
Jeremy Gebben9f537102021-10-05 16:37:12 -06001027std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1028 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001029 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001030}
John Zulaufa4472282019-08-22 14:44:34 -06001031
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001032template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001033void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001034 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001035 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001036 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001037 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001038 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001039 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001040 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001041 }
John Zulaufa4472282019-08-22 14:44:34 -06001042
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001043 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1044 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001045 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1046 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001047 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1048
1049 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001050 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1051 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1052 auto handle_state = BarrierHandleState(*this, barrier);
1053 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1054 if (!mode_concurrent) {
1055 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001056 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001057 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001058 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1059 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001060 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001061 src_queue_family, dst_queue_family);
1062 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001063 }
1064 }
1065}
1066
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001067// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001068template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001069bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001070 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1071 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001072 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1073 using sync_vuid_maps::GetImageBarrierVUID;
1074 using sync_vuid_maps::ImageError;
1075
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001076 bool skip = false;
1077 const auto *fb_state = framebuffer;
1078 assert(fb_state);
1079 const auto img_bar_image = img_barrier.image;
1080 bool image_match = false;
1081 bool sub_image_found = false; // Do we find a corresponding subpass description
1082 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1083 uint32_t attach_index = 0;
1084 // Verify that a framebuffer image matches barrier image
1085 const auto attachment_count = fb_state->createInfo.attachmentCount;
1086 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001087 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001088 if (view_state && (img_bar_image == view_state->create_info.image)) {
1089 image_match = true;
1090 attach_index = attachment;
1091 break;
1092 }
1093 }
1094 if (image_match) { // Make sure subpass is referring to matching attachment
1095 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1096 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1097 sub_image_found = true;
1098 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001099 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001100 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1101 if (resolve && resolve->pDepthStencilResolveAttachment &&
1102 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1103 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1104 sub_image_found = true;
1105 }
1106 }
1107 if (!sub_image_found) {
1108 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1109 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1110 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1111 sub_image_found = true;
1112 break;
1113 }
1114 if (!sub_image_found && sub_desc.pResolveAttachments &&
1115 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1116 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1117 sub_image_found = true;
1118 break;
1119 }
1120 }
1121 }
1122 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001123 auto img_loc = loc.dot(Field::image);
1124 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1125 skip |=
1126 LogError(rp_handle, vuid,
1127 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1128 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1129 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001130 }
1131 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001132 auto img_loc = loc.dot(Field::image);
1133 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001134 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 -07001135 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001136 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001137 }
1138 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001139 auto layout_loc = loc.dot(Field::oldLayout);
1140 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001141 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001142 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001143 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001144 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001145 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1146 } else {
1147 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1148 LogObjectList objlist(rp_handle);
1149 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001150 auto layout_loc = loc.dot(Field::oldLayout);
1151 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1152 skip |= LogError(objlist, vuid,
1153 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001154 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001155 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001156 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1157 string_VkImageLayout(img_barrier.oldLayout));
1158 }
1159 }
1160 return skip;
1161}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001162// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001163template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001164 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1165 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1166 const VkImageMemoryBarrier &img_barrier,
1167 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001168template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001169 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1170 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1171 const VkImageMemoryBarrier2KHR &img_barrier,
1172 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001173
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001174template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001175void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001176 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001177 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1178 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1179 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1180 const auto active_subpass = cb_state->activeSubpass;
1181 const auto rp_state = cb_state->activeRenderPass;
1182 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001183 // Secondary CB case w/o FB specified delay validation
1184 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001185 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001186 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001187 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001188 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1189 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1190 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001191 render_pass, barrier, primary_cb);
1192 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001193 }
1194}
1195
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001196void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001197 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1198 const VkImageMemoryBarrier *pImageMemBarriers) {
1199 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001200 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001201 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1202 }
1203 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001204 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001205 const auto &img_barrier = pImageMemBarriers[i];
1206 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1207 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1208 }
1209}
1210
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001211void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001213 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001214 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1215 }
1216 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001217 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001218 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1219 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1220 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1221 }
1222}
1223
1224template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001225bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001226 const char *operation, const TransferBarrier &barrier,
1227 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001228 // Record to the scoreboard or report that we have a duplication
1229 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001230 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001231 if (!inserted.second && inserted.first->second != cb_state) {
1232 // 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 -06001233 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001234 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001235 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001236 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001237 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1238 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001239 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001240 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001241 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001242 }
1243 return skip;
1244}
1245
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001246template <typename TransferBarrier>
1247bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1248 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1249 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001250 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001251 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001252 const char *barrier_name = TransferBarrier::BarrierName();
1253 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001254 // No release should have an extant duplicate (WARNING)
1255 for (const auto &release : cb_barriers.release) {
1256 // Check the global pending release barriers
1257 const auto set_it = global_release_barriers.find(release.handle);
1258 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001259 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001260 const auto found = set_for_handle.find(release);
1261 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001262 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001263 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1264 " to dstQueueFamilyIndex %" PRIu32
1265 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1266 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1267 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001268 }
1269 }
1270 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1271 }
1272 // Each acquire must have a matching release (ERROR)
1273 for (const auto &acquire : cb_barriers.acquire) {
1274 const auto set_it = global_release_barriers.find(acquire.handle);
1275 bool matching_release_found = false;
1276 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001277 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001278 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1279 }
1280 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001281 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001282 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1283 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1284 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1285 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001286 }
1287 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1288 }
1289 return skip;
1290}
1291
John Zulauf3b04ebd2019-07-18 14:08:11 -06001292bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001293 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1294 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001295 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001296 skip |=
1297 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1298 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1299 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001300 return skip;
1301}
1302
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001303template <typename TransferBarrier>
1304void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1305 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001306 // Add release barriers from this submit to the global map
1307 for (const auto &release : cb_barriers.release) {
1308 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001309 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1310 // copy back after updating.
1311 auto iter = global_release_barriers.find(release.handle);
1312 iter->second.insert(release);
1313 global_release_barriers.insert_or_assign(release.handle, iter->second);
John Zulauf6b4aae82018-05-09 13:03:36 -06001314 }
1315
1316 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1317 for (const auto &acquire : cb_barriers.acquire) {
1318 // NOTE: We're not using [] because we don't want to create entries for missing releases
1319 auto set_it = global_release_barriers.find(acquire.handle);
1320 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001321 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001322 set_for_handle.erase(acquire);
1323 if (set_for_handle.size() == 0) { // Clean up empty sets
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001324 global_release_barriers.erase(acquire.handle);
1325 } else {
1326 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1327 // copy back after updating.
1328 global_release_barriers.insert_or_assign(acquire.handle, set_for_handle);
John Zulauf6b4aae82018-05-09 13:03:36 -06001329 }
1330 }
1331 }
1332}
1333
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001334void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001335 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1336 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1337 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001338}
1339
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001340template <typename ImgBarrier>
1341void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1342 // For ownership transfers, the barrier is specified twice; as a release
1343 // operation on the yielding queue family, and as an acquire operation
1344 // on the acquiring queue family. This barrier may also include a layout
1345 // transition, which occurs 'between' the two operations. For validation
1346 // purposes it doesn't seem important which side performs the layout
1347 // transition, but it must not be performed twice. We'll arbitrarily
1348 // choose to perform it as part of the acquire operation.
1349 //
1350 // However, we still need to record initial layout for the "initial layout" validation
1351 for (uint32_t i = 0; i < barrier_count; i++) {
1352 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001353 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001354 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001355 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001356 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001357 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001358 }
1359}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001360// explictly instantiate this template so it can be used in core_validation.cpp
1361template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1362 const VkImageMemoryBarrier *barrier);
1363template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1364 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001365
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001366VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1367
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001368template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001369void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001370 const ImgBarrier &mem_barrier, bool is_release_op) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06001371 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001372 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1373 return;
1374 }
1375 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001376 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001377
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001378 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1379 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001380
1381 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001382 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001383 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1384 }
1385
John Zulauf2be3fe02019-12-30 09:48:02 -07001386 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001387 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001388 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001389 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001390 }
unknown86bcb3a2019-07-11 13:05:36 -06001391}
1392
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001393bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1394 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1395 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1396 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001397 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001398 assert(cb_node);
1399 assert(image_state);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001400 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001401
Jeremy Gebben6335df62021-11-01 10:50:13 -06001402 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06001403 if (subresource_map) {
1404 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001405 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001406 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1407 // the next "constant value" range
1408 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001409 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001410 *error = true;
Jeremy Gebben6335df62021-11-01 10:50:13 -06001411 subres_skip |=
1412 LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
1413 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1414 "%s layout %s.",
1415 caller, report_data->FormatHandle(image_state->Handle()).c_str(), pos->subresource.arrayLayer,
1416 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1417 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001418 }
John Zulauf5e617452019-11-19 14:44:16 -07001419 }
John Zulauff660ad62019-03-23 07:16:05 -06001420 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001421 }
John Zulauff660ad62019-03-23 07:16:05 -06001422
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001423 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1424 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1425 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001426 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1427 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001428 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001429 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001430 report_data->FormatHandle(image_state->Handle()).c_str(),
1431 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001432 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001433 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001434 if (image_state->shared_presentable) {
1435 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001436 skip |=
1437 LogError(device, layout_invalid_msg_code,
1438 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1439 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001440 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001441 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001442 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001443 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001444 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001445 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001446 report_data->FormatHandle(image_state->Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001447 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001448 }
1449 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001450 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001451}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001452bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001453 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1454 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001455 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001456 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1457 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1458}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001459
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001460void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001461 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001462 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001463 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001464
Mike Schuchardt2df08912020-12-15 16:28:09 -08001465 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001466 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001467 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001468 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001469 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001470 VkImageLayout stencil_layout = kInvalidLayout;
1471 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001472 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001473 if (attachment_description_stencil_layout) {
1474 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1475 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001476 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001477 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001478 }
1479 }
1480}
Dave Houltone19e20d2018-02-02 16:32:41 -07001481
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001482#ifdef VK_USE_PLATFORM_ANDROID_KHR
1483// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1484// This could also move into a seperate core_validation_android.cpp file... ?
1485
1486//
1487// AHB-specific validation within non-AHB APIs
1488//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001489bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001490 bool skip = false;
1491
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001492 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001493 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001494 if (0 != ext_fmt_android->externalFormat) {
1495 if (VK_FORMAT_UNDEFINED != create_info->format) {
1496 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001497 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1498 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1499 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001500 }
1501
1502 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001503 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1504 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1505 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001506 }
1507
1508 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001509 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1510 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001511 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001512 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001513 }
1514
1515 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001516 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1517 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1518 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001519 }
1520 }
1521
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001522 if ((0 != ext_fmt_android->externalFormat) &&
1523 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001524 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001525 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1526 ") which has "
1527 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1528 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001529 }
1530 }
1531
Dave Houltond9611312018-11-19 17:03:36 -07001532 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001533 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001534 skip |=
1535 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1536 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1537 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001538 }
1539 }
1540
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001541 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001542 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1543 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001544 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001545 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1546 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1547 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1548 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001549 }
1550
1551 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001552 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1553 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1554 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1555 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1556 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001557 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001558 }
1559
1560 return skip;
1561}
1562
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001563bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001564 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001565 const auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001566
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001567 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001568 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001569 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1570 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001571 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001572 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001573 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001574
Dave Houltond9611312018-11-19 17:03:36 -07001575 // Chain must include a compatible ycbcr conversion
1576 bool conv_found = false;
1577 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001578 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001579 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001580 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001581 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001582 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001583 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001584 }
Dave Houltond9611312018-11-19 17:03:36 -07001585 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001586 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001587 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001588 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1589 "an externalFormat (%" PRIu64
1590 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1591 "with the same external format.",
1592 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001593 }
1594
1595 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001596 if (IsIdentitySwizzle(create_info->components) == false) {
1597 skip |= LogError(
1598 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1599 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1600 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1601 "= %s.",
1602 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1603 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001604 }
1605 }
Dave Houltond9611312018-11-19 17:03:36 -07001606
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001607 return skip;
1608}
1609
John Zulaufa26d3c82019-08-14 16:09:08 -06001610bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001611 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001612
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001613 const auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001614 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001615 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001616 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1617 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1618 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1619 "bound to memory.");
1620 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001621 }
1622 return skip;
1623}
1624
1625#else
1626
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001627bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001628 return false;
1629}
1630
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001631bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001632
John Zulaufa26d3c82019-08-14 16:09:08 -06001633bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001634
1635#endif // VK_USE_PLATFORM_ANDROID_KHR
1636
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001637bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1638 bool skip = false;
1639
1640 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001641 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001642 const VkImageTiling image_tiling = pCreateInfo->tiling;
1643 const VkFormat image_format = pCreateInfo->format;
1644
1645 if (image_format == VK_FORMAT_UNDEFINED) {
1646 // VU 01975 states format can't be undefined unless an android externalFormat
1647#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001648 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001649 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1650 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1651 if (it != ahb_ext_formats_map.end()) {
1652 tiling_features = it->second;
1653 }
1654 }
1655#endif
1656 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001657 layer_data::unordered_set<uint64_t> drm_format_modifiers;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001658 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001659 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001660 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001661 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001662
1663 if (drm_explicit != nullptr) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001664 drm_format_modifiers.insert(drm_explicit->drmFormatModifier);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001665 } else {
1666 // VUID 02261 makes sure its only explict or implict in parameter checking
1667 assert(drm_implicit != nullptr);
1668 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001669 drm_format_modifiers.insert(drm_implicit->pDrmFormatModifiers[i]);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001670 }
1671 }
1672
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001673 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
1674 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
1675 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001676 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001677 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
1678 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
1679 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001680
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001681 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
1682 if (drm_format_modifiers.find(fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier) !=
1683 drm_format_modifiers.end()) {
1684 tiling_features |= fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001685 }
1686 }
1687 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001688 VkFormatProperties3KHR format_properties = GetPDFormatProperties(image_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001689 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1690 : format_properties.optimalTilingFeatures;
1691 }
1692
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001693 // Lack of disjoint format feature support while using the flag
1694 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001695 ((tiling_features & VK_FORMAT_FEATURE_2_DISJOINT_BIT_KHR) == 0)) {
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001696 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1697 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1698 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1699 string_VkFormat(pCreateInfo->format));
1700 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001701
1702 return skip;
1703}
1704
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001705bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001706 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001707 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001708
sfricke-samsung45996a42021-09-16 13:45:27 -07001709 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001710 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001711 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1712 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001713 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1714 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001715 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001716 }
1717
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001718 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1719 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001720 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1721 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1722 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001723 }
Dave Houlton130c0212018-01-29 13:39:56 -07001724 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001725
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001726 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001727 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1728 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1729 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001730 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001731 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1732 "device maxFramebufferWidth (%u).",
1733 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001734 }
1735
1736 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001737 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001738 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1739 "device maxFramebufferHeight (%u).",
1740 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001741 }
1742
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001743 VkImageCreateFlags sparseFlags =
1744 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1745 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1746 skip |= LogError(
1747 device, "VUID-VkImageCreateInfo-None-01925",
1748 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1749 }
1750
sfricke-samsung45996a42021-09-16 13:45:27 -07001751 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map) ||
1752 IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001753 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1754 static_cast<float>(device_limits->maxFramebufferWidth) /
1755 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001756 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1757 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001758 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1759 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1760 "ceiling of device "
1761 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1762 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1763 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001764 }
1765
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001766 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1767 static_cast<float>(device_limits->maxFramebufferHeight) /
1768 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001769 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1770 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001771 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1772 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1773 "ceiling of device "
1774 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1775 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1776 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001777 }
1778 }
1779
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001780 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001781 VkResult result = VK_SUCCESS;
1782 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1783 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1784 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1785 &format_limits);
1786 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001787 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1788 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001789 if (modifier_list) {
1790 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001791 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001792 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001793 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001794 image_format_info.type = pCreateInfo->imageType;
1795 image_format_info.format = pCreateInfo->format;
1796 image_format_info.tiling = pCreateInfo->tiling;
1797 image_format_info.usage = pCreateInfo->usage;
1798 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001799 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001800
1801 result =
1802 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1803 format_limits = image_format_properties.imageFormatProperties;
1804
1805 /* The application gives a list of modifier and the driver
1806 * selects one. If one is wrong, stop there.
1807 */
1808 if (result != VK_SUCCESS) break;
1809 }
1810 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001811 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001812 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001813 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001814 image_format_info.type = pCreateInfo->imageType;
1815 image_format_info.format = pCreateInfo->format;
1816 image_format_info.tiling = pCreateInfo->tiling;
1817 image_format_info.usage = pCreateInfo->usage;
1818 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001819 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001820
1821 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1822 format_limits = image_format_properties.imageFormatProperties;
1823 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001824 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001825
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001826 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1827 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1828 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1829 if (result != VK_SUCCESS) {
1830 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001831#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001832 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001833#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001834 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001835 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001836 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1837 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001838#ifdef VK_USE_PLATFORM_ANDROID_KHR
1839 }
1840#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001841 } else {
1842 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1843 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001844 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1845 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1846 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001847 }
Dave Houlton130c0212018-01-29 13:39:56 -07001848
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001849 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1850 static_cast<uint64_t>(pCreateInfo->extent.height) *
1851 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1852 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001853
sfricke-samsung2e827212021-09-28 07:52:08 -07001854 // Depth/Stencil formats size can't be accurately calculated
1855 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1856 uint64_t total_size =
1857 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001858
sfricke-samsung2e827212021-09-28 07:52:08 -07001859 // Round up to imageGranularity boundary
1860 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1861 uint64_t ig_mask = image_granularity - 1;
1862 total_size = (total_size + ig_mask) & ~ig_mask;
1863
1864 if (total_size > format_limits.maxResourceSize) {
1865 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1866 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1867 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1868 total_size, format_limits.maxResourceSize);
1869 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001870 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001871
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001872 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001873 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1874 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1875 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001876 }
1877
1878 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001879 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1880 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1881 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001882 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001883
1884 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1885 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1886 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1887 pCreateInfo->extent.width, format_limits.maxExtent.width);
1888 }
1889
1890 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1891 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1892 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1893 pCreateInfo->extent.height, format_limits.maxExtent.height);
1894 }
1895
1896 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1897 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1898 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1899 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1900 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001901 }
1902
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001903 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001904 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001905 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001906 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001907 ? "VUID-VkImageCreateInfo-format-06414"
1908 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001909 skip |= LogError(device, error_vuid,
1910 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1911 "YCbCr Conversion format, arrayLayers must be 1",
1912 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001913 }
1914
1915 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001916 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001917 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1918 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001919 }
1920
1921 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001922 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001923 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001924 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1925 string_VkSampleCountFlagBits(pCreateInfo->samples));
1926 }
1927
1928 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001929 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001930 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001931 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1932 string_VkImageType(pCreateInfo->imageType));
1933 }
1934 }
1935
sfricke-samsung45996a42021-09-16 13:45:27 -07001936 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001937 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001938 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001939 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1940 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001941 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001942 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001943 }
1944 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001945 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1946 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1947 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001948 }
1949 }
1950 }
1951
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001952 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001953 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1954 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1955 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001956 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001957 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001958 }
1959
unknown2c877272019-07-11 12:56:50 -06001960 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1961 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1962 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001963 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1964 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1965 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001966 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001967
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001968 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001969 if (swapchain_create_info != nullptr) {
1970 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001971 const auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001972 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1973
1974 // Validate rest of Swapchain Image create check that require swapchain state
1975 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1976 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1977 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1978 skip |= LogError(
1979 device, vuid,
1980 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1981 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1982 }
1983 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1984 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1985 skip |= LogError(device, vuid,
1986 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1987 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1988 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08001989 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001990 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1991 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1992 skip |= LogError(device, vuid,
1993 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1994 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08001995 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001996 }
1997 }
1998 }
1999
sfricke-samsungedce77a2020-07-03 22:35:13 -07002000 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2001 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2002 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2003 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2004 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2005 }
2006 const VkImageCreateFlags invalid_flags =
2007 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2008 if ((pCreateInfo->flags & invalid_flags) != 0) {
2009 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2010 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2011 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2012 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2013 }
2014 }
2015
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002016 skip |= ValidateImageFormatFeatures(pCreateInfo);
2017
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002018 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002019 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002020 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2021 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2022 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2023 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2024 }
2025 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2026 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2027 skip |=
2028 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2029 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2030 }
2031 }
2032
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002033 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002034 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2035 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2036 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2037 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2038 "VkExternalMemoryImageCreateInfo chained structs.");
2039 }
2040 if (external_memory_create_info) {
2041 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2042 skip |= LogError(
2043 device, "VUID-VkImageCreateInfo-pNext-01443",
2044 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2045 " but pCreateInfo->initialLayout is %s.",
2046 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2047 }
2048 } else if (external_memory_create_info_nv) {
2049 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2050 skip |= LogError(
2051 device, "VUID-VkImageCreateInfo-pNext-01443",
2052 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2053 " but pCreateInfo->initialLayout is %s.",
2054 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002055 }
2056 }
2057
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002058 if (device_group_create_info.physicalDeviceCount == 1) {
2059 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2060 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2061 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2062 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2063 }
2064 }
2065
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002066 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002067}
2068
John Zulauf7eeb6f72019-06-17 11:56:36 -06002069void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2070 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2071 if (VK_SUCCESS != result) return;
2072
2073 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07002074 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) != 0) {
2075 // non-sparse images set up their layout maps when memory is bound
2076 auto image_state = Get<IMAGE_STATE>(*pImage);
2077 image_state->SetInitialLayoutMap();
2078 }
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002079}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002080
Jeff Bolz5c801d12019-10-09 10:38:45 -05002081bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002082 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002083 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002084 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002085 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002086 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002087 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2088 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002089 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002090 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002091 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002092 }
2093 return skip;
2094}
2095
John Zulauf7eeb6f72019-06-17 11:56:36 -06002096void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2097 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002098 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002099 qfo_release_image_barrier_map.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002100 // Clean up generic image state
2101 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002102}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002103
sfricke-samsungcd924d92020-05-20 23:51:17 -07002104bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2105 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002106 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002107 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002108 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002109
2110 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002111 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2112 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002113 }
2114
sfricke-samsungcd924d92020-05-20 23:51:17 -07002115 if (FormatIsDepthOrStencil(format)) {
2116 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2117 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2118 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2119 } else if (FormatIsCompressed(format)) {
2120 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2121 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2122 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002123 }
2124
2125 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002126 skip |=
2127 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2128 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2129 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002130 }
2131 return skip;
2132}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002133
John Zulauf07288512019-07-05 11:09:50 -06002134bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2135 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2136 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002137 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002138 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2139 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002140 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002141 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2142 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002143 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002144
2145 } else {
2146 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002147 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002148 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002149 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002150 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2151 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002152 }
2153 } else {
2154 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2155 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002156 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002157 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002158 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2159 func_name, string_VkImageLayout(dest_image_layout));
2160 }
2161 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002162 }
2163
John Zulauff660ad62019-03-23 07:16:05 -06002164 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002165 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002166 if (subresource_map) {
2167 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002168 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002169 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002170 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2171 // the next "constant value" range
2172 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002173 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002174 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2175 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2176 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2177 } else {
2178 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002179 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002180 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002181 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2182 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2183 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002184 }
John Zulauf5e617452019-11-19 14:44:16 -07002185 }
John Zulauff660ad62019-03-23 07:16:05 -06002186 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002187 }
2188
2189 return skip;
2190}
2191
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002192bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2193 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002194 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002195 bool skip = false;
2196 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002197 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002198 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002199 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002200 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2201 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002202 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002203 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
2204 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002205 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002206 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2207 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2208 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002209 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002210 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002211 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002212 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2213 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2214 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002215 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002216 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002217 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002218 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2219 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2220 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2221 string_VkFormat(image_state->createInfo.format));
2222 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002223 }
2224 return skip;
2225}
2226
John Zulaufeabb4462019-07-05 14:13:03 -06002227void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2228 const VkClearColorValue *pColor, uint32_t rangeCount,
2229 const VkImageSubresourceRange *pRanges) {
2230 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2231
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002232 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002233 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002234 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002235 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002236 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002237 }
2238 }
2239}
2240
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002241bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2242 const char *apiName) const {
2243 bool skip = false;
2244
2245 // 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 -07002246 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002247 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2248 // Also VUID-VkClearDepthStencilValue-depth-00022
2249 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2250 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2251 "(=%f) is not within the [0.0, 1.0] range.",
2252 apiName, clearValue.depth);
2253 }
2254 }
2255
2256 return skip;
2257}
2258
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002259bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2260 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002261 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002262 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002263
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002264 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002265 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002266 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002267 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002268 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002269 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002270 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002271 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002272 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002273 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06002274 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002275 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002276 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002277 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002278 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002279 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002280 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002281
2282 bool any_include_aspect_depth_bit = false;
2283 bool any_include_aspect_stencil_bit = false;
2284
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002285 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002286 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002287 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2288 skip |=
2289 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002290 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002291 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2292 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002293 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2294 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2295 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2296 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002297 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002298 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2299 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002300 if (FormatHasDepth(image_format) == false) {
2301 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2302 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2303 "doesn't have a depth component.",
2304 i, string_VkFormat(image_format));
2305 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002306 }
2307 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2308 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002309 if (FormatHasStencil(image_format) == false) {
2310 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2311 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2312 "%s doesn't have a stencil component.",
2313 i, string_VkFormat(image_format));
2314 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002315 }
2316 }
2317 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002318 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002319 if (image_stencil_struct != nullptr) {
2320 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2321 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002322 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2323 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2324 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2325 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002326 }
2327 } else {
2328 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002329 skip |= LogError(
2330 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002331 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2332 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2333 "in VkImageCreateInfo::usage used to create image");
2334 }
2335 }
2336 }
2337 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002338 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2339 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2340 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002341 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002342 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002343 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2344 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002345 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002346 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002347 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002348 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2349 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2350 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2351 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002352 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002353 }
2354 return skip;
2355}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002356
John Zulaufeabb4462019-07-05 14:13:03 -06002357void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2358 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2359 const VkImageSubresourceRange *pRanges) {
2360 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002361
2362 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002363 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002364 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002365 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002366 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002367 }
2368 }
2369}
2370
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002371// Returns true if [x, xoffset] and [y, yoffset] overlap
2372static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2373 bool result = false;
2374 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2375 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2376
2377 if (intersection_max > intersection_min) {
2378 result = true;
2379 }
2380 return result;
2381}
2382
Jeff Leger178b1e52020-10-05 12:22:23 -04002383// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002384// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002385template <typename RegionType>
2386static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002387 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002388
Dave Houltonc991cc92018-03-06 11:08:51 -07002389 // Separate planes within a multiplane image cannot intersect
2390 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002391 return result;
2392 }
2393
Dave Houltonc991cc92018-03-06 11:08:51 -07002394 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2395 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2396 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002397 result = true;
2398 switch (type) {
2399 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002400 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002401 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002402 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002403 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002404 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002405 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002406 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002407 break;
2408 default:
2409 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2410 assert(false);
2411 }
2412 }
2413 return result;
2414}
2415
Dave Houltonfc1a4052017-04-27 14:32:45 -06002416// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002417static const uint32_t kXBit = 1;
2418static const uint32_t kYBit = 2;
2419static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002420static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002421 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002422 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002423 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2424 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002425 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002426 }
2427 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2428 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002429 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002430 }
2431 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2432 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002433 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002434 }
2435 return result;
2436}
2437
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002438// Test if two VkExtent3D structs are equivalent
2439static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2440 bool result = true;
2441 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2442 (extent->depth != other_extent->depth)) {
2443 result = false;
2444 }
2445 return result;
2446}
2447
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002448// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002449static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002450 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2451}
2452
2453// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002454VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002455 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2456 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002457 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002458 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002459 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002460 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002461 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002462 granularity.width *= block_size.width;
2463 granularity.height *= block_size.height;
2464 }
2465 }
2466 return granularity;
2467}
2468
2469// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2470static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2471 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002472 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2473 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474 valid = false;
2475 }
2476 return valid;
2477}
2478
2479// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002480bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002481 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002482 bool skip = false;
2483 VkExtent3D offset_extent = {};
2484 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2485 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2486 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002487 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002488 // 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 -07002489 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002490 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002491 "%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 "
2492 "image transfer granularity is (w=0, h=0, d=0).",
2493 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002494 }
2495 } else {
2496 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2497 // integer multiples of the image transfer granularity.
2498 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002499 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002500 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2501 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2502 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2503 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002504 }
2505 }
2506 return skip;
2507}
2508
2509// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002510bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002511 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002512 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002513 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002514 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002515 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2516 // subresource extent.
2517 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002518 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002519 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2520 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2521 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2522 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002523 }
2524 } else {
2525 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2526 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2527 // subresource extent dimensions.
2528 VkExtent3D offset_extent_sum = {};
2529 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2530 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2531 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002532 bool x_ok = true;
2533 bool y_ok = true;
2534 bool z_ok = true;
2535 switch (image_type) {
2536 case VK_IMAGE_TYPE_3D:
2537 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2538 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002539 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002540 case VK_IMAGE_TYPE_2D:
2541 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2542 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002543 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002544 case VK_IMAGE_TYPE_1D:
2545 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2546 (subresource_extent->width == offset_extent_sum.width));
2547 break;
2548 default:
2549 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2550 assert(false);
2551 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002552 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002553 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002554 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2556 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2557 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2558 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2559 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2560 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002561 }
2562 }
2563 return skip;
2564}
2565
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002566bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002567 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002568 bool skip = false;
2569 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002570 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2571 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002572 }
2573 return skip;
2574}
2575
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002576bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002577 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002578 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002579 bool skip = false;
2580 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2581 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002582 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002583 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2584 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002585 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002586 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002587 }
2588 return skip;
2589}
2590
Jeff Leger178b1e52020-10-05 12:22:23 -04002591// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2592template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002593bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002594 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002595 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002596 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002597 VkExtent3D granularity = GetScaledItg(cb_node, img);
2598 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002599 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002600 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002601 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002602 return skip;
2603}
2604
Jeff Leger178b1e52020-10-05 12:22:23 -04002605// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2606template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002607bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002608 const IMAGE_STATE *dst_img, const RegionType *region,
2609 const uint32_t i, const char *function,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002610 CMD_TYPE cmd_type) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002611 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002612 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04002613 const char *vuid;
2614
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002615 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002616 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002617 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Jeff Leger178b1e52020-10-05 12:22:23 -04002618 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002619 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002620 const VkExtent3D extent = region->extent;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002621 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002622 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002623 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002624
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002625 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002626 granularity = GetScaledItg(cb_node, dst_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002627 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Jeff Leger178b1e52020-10-05 12:22:23 -04002628 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002629 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002630 const VkExtent3D dest_effective_extent =
2631 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002632 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002633 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002634 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002635 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636 return skip;
2637}
2638
Jeff Leger178b1e52020-10-05 12:22:23 -04002639// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2640template <typename ImageCopyRegionType>
2641bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2642 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002643 CMD_TYPE cmd_type) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002644 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002645 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
2646 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002647 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002648
2649 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002650 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002651
2652 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002653 const VkExtent3D src_copy_extent = region.extent;
2654 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002655 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2656
Dave Houlton6f9059e2017-05-02 17:15:13 -06002657 bool slice_override = false;
2658 uint32_t depth_slices = 0;
2659
2660 // Special case for copying between a 1D/2D array and a 3D image
2661 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2662 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002663 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 slice_override = (depth_slices != 1);
2665 } 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 -07002666 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002667 slice_override = (depth_slices != 1);
2668 }
2669
2670 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002671 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002672 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002673 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002674 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002675 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2676 "be 0 and 1, respectively.",
2677 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002678 }
2679 }
2680
Dave Houlton533be9f2018-03-26 17:08:30 -06002681 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002682 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002683 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002684 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002685 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002686 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002687 }
2688
Dave Houlton533be9f2018-03-26 17:08:30 -06002689 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002690 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002691 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 -04002692 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002693 }
2694
sfricke-samsung01da6312021-10-20 07:51:32 -07002695 // Source checks that apply only to "blocked images"
2696 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002697 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002698 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002699 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2700 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2701 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002702 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002703 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002704 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002705 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002706 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002707 }
2708
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002709 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002710 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2711 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002712 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002713 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002714 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002715 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2716 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002717 }
2718
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002719 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002720 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2721 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002722 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002723 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002724 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2725 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2726 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002727 }
2728
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002729 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002730 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2731 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002732 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002733 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2735 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2736 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002737 }
2738 } // Compressed
2739
2740 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002741 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002742 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002743 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002744 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002745 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002746 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002747 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002748 }
2749 }
2750
Dave Houlton533be9f2018-03-26 17:08:30 -06002751 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002752 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002753 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002754 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2755 "and 1, respectively.",
2756 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002757 }
2758
Dave Houlton533be9f2018-03-26 17:08:30 -06002759 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002760 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002761 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 -04002762 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002763 }
2764
sfricke-samsung30b094c2020-05-30 11:42:11 -07002765 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002766 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002767 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2768 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002769 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002770 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2772 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2773 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002774 }
2775 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002776 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002777 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002778 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002779 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002780 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2781 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2782 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002783 }
2784 }
2785 } else { // Pre maint 1
2786 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002787 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002788 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002789 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002790 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002791 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2792 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002793 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002794 }
Dave Houltonee281a52017-12-08 13:51:02 -07002795 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002796 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002797 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002798 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002799 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2800 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002801 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002802 }
2803 }
2804 }
2805
sfricke-samsung01da6312021-10-20 07:51:32 -07002806 // Dest checks that apply only to "blocked images"
2807 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002808 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002809
2810 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002811 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2812 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2813 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002814 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002815 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002816 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002817 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002818 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002819 }
2820
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002821 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002822 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2823 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002824 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002825 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002826 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002827 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2828 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002829 }
2830
Dave Houltonee281a52017-12-08 13:51:02 -07002831 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2832 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2833 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002834 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002835 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002836 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002837 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2838 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002839 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002840 }
2841
Dave Houltonee281a52017-12-08 13:51:02 -07002842 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2843 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2844 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002845 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002846 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002847 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2848 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2849 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002850 }
2851 } // Compressed
2852 }
2853 return skip;
2854}
2855
Jeff Leger178b1e52020-10-05 12:22:23 -04002856template <typename RegionType>
2857bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2858 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002859 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002860 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002861 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
2862 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002863 const VkFormat src_format = src_image_state->createInfo.format;
2864 const VkFormat dst_format = dst_image_state->createInfo.format;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002865 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002866 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002867
sfricke-samsung85584a72021-09-30 21:43:38 -07002868 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002869 const char *vuid;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002870 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), cmd_type);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002871
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002872 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002873
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002874 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002875 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002876
2877 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2878 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002879 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002880
Dave Houlton6f9059e2017-05-02 17:15:13 -06002881 bool slice_override = false;
2882 uint32_t depth_slices = 0;
2883
2884 // Special case for copying between a 1D/2D array and a 3D image
2885 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2886 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2887 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002888 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002889 slice_override = (depth_slices != 1);
2890 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2891 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002892 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002893 slice_override = (depth_slices != 1);
2894 }
2895
Jeremy Gebben9f537102021-10-05 16:37:12 -06002896 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
2897 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002898 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2899 skip |=
2900 ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2901 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2902 skip |=
2903 ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2904 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002905 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002906 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002907 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002908 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002909 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002910
sfricke-samsung45996a42021-09-16 13:45:27 -07002911 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002912 // No chance of mismatch if we're overriding depth slice count
2913 if (!slice_override) {
2914 // The number of depth slices in srcSubresource and dstSubresource must match
2915 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2916 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002917 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2918 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002919 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002920 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2921 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002922 if (src_slices != dst_slices) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002923 vuid = is_2 ? "VUID-VkImageCopy2-extent-00140" : "VUID-VkImageCopy-extent-00140";
Jeff Leger178b1e52020-10-05 12:22:23 -04002924 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002925 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2926 "do not match.",
2927 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002928 }
2929 }
2930 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002931 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002932 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002933 vuid = is_2 ? "VUID-VkImageCopy2-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002934 skip |=
2935 LogError(command_buffer, vuid,
2936 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2937 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002938 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002939 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002940
Dave Houltonc991cc92018-03-06 11:08:51 -07002941 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002942 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002943 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2944 // If neither image is multi-plane the aspectMask member of src and dst must match
2945 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002946 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002947 skip |= LogError(command_buffer, vuid,
2948 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2949 "source (0x%x) destination (0x%x).",
2950 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2951 }
2952 } else {
2953 // Source image multiplane checks
2954 uint32_t planes = FormatPlaneCount(src_format);
2955 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2956 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002957 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002958 skip |= LogError(command_buffer, vuid,
2959 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2960 i, aspect);
2961 }
2962 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2963 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002964 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002965 skip |= LogError(command_buffer, vuid,
2966 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2967 i, aspect);
2968 }
2969 // Single-plane to multi-plane
2970 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2971 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002972 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002973 skip |= LogError(command_buffer, vuid,
2974 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2975 func_name, i, aspect);
2976 }
Dave Houltonc991cc92018-03-06 11:08:51 -07002977
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002978 // Dest image multiplane checks
2979 planes = FormatPlaneCount(dst_format);
2980 aspect = region.dstSubresource.aspectMask;
2981 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002982 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002983 skip |= LogError(command_buffer, vuid,
2984 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2985 i, aspect);
2986 }
2987 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2988 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002989 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002990 skip |= LogError(command_buffer, vuid,
2991 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2992 i, aspect);
2993 }
2994 // Multi-plane to single-plane
2995 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
2996 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002997 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002998 skip |= LogError(command_buffer, vuid,
2999 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3000 func_name, i, aspect);
3001 }
3002 }
3003 } else {
3004 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003005 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3006 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003007 vuid = is_2 ? "VUID-VkImageCopy2-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003008 skip |= LogError(
3009 command_buffer, vuid,
3010 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3011 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003012 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003013 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003014
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003015 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003016 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003017 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003018 skip |=
3019 LogError(command_buffer, vuid,
3020 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3021 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003022 }
3023
3024 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003025 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003026 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003027 skip |= LogError(
3028 command_buffer, vuid,
3029 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3030 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003031 }
3032
Dave Houltonfc1a4052017-04-27 14:32:45 -06003033 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003034 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003035 if (slice_override) src_copy_extent.depth = depth_slices;
3036 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003037 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003038 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
Jeff Leger178b1e52020-10-05 12:22:23 -04003039 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003040 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003041 "width [%1d].",
3042 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003043 }
3044
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003045 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003046 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
Jeff Leger178b1e52020-10-05 12:22:23 -04003047 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003048 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 "height [%1d].",
3050 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003051 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003052 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003053 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
Jeff Leger178b1e52020-10-05 12:22:23 -04003054 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003055 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003056 "depth [%1d].",
3057 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003058 }
3059
Dave Houltonee281a52017-12-08 13:51:02 -07003060 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003061 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003062 if (slice_override) dst_copy_extent.depth = depth_slices;
3063
3064 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003065 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003066 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
Jeff Leger178b1e52020-10-05 12:22:23 -04003067 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003068 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003069 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003070 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003071 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003072 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003073 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
Jeff Leger178b1e52020-10-05 12:22:23 -04003074 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003075 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003076 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003077 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003078 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003079 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003080 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
Jeff Leger178b1e52020-10-05 12:22:23 -04003081 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003082 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003083 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003084 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003085 }
3086
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003087 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3088 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003089 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003090 for (uint32_t j = 0; j < regionCount; j++) {
3091 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003092 FormatIsMultiplane(src_format))) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003093 vuid = is_2 ? "VUID-VkCopyImageInfo2-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003094 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003095 }
3096 }
3097 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003098
3099 // 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 -07003100 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003101 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3102 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3103 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003104 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
Jeff Leger178b1e52020-10-05 12:22:23 -04003105 skip |= LogError(command_buffer, vuid,
3106 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3107 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003108 }
3109 } else {
3110 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3111 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3112 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003113 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
Jeff Leger178b1e52020-10-05 12:22:23 -04003114 skip |= LogError(command_buffer, vuid,
3115 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3116 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003117 }
3118 }
3119
3120 // Check if 2D with 3D and depth not equal to 2D layerCount
3121 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3122 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3123 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003124 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
Jeff Leger178b1e52020-10-05 12:22:23 -04003125 skip |= LogError(command_buffer, vuid,
3126 "%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 -08003127 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003128 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003129 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3130 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3131 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003132 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
Jeff Leger178b1e52020-10-05 12:22:23 -04003133 skip |= LogError(command_buffer, vuid,
3134 "%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 -08003135 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003136 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003137 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003138
3139 // Check for multi-plane format compatiblity
3140 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003141 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3142 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3143 : src_format;
3144 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3145 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3146 : dst_format;
3147 const size_t src_format_size = FormatElementSize(src_plane_format);
3148 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3149
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003150 // If size is still zero, then format is invalid and will be caught in another VU
3151 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003152 vuid = is_2 ? "VUID-VkCopyImageInfo2-None-01549" : "VUID-vkCmdCopyImage-None-01549";
Jeff Leger178b1e52020-10-05 12:22:23 -04003153 skip |= LogError(command_buffer, vuid,
3154 "%s: pRegions[%u] called with non-compatible image formats. "
3155 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3156 func_name, i, string_VkFormat(src_format),
3157 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3158 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003159 }
3160 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003161 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003162
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003163 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3164 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3165 // because because both texels are 4 bytes in size.
3166 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003167 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003168 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003169 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3170 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003171 // Depth/stencil formats must match exactly.
3172 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3173 if (src_format != dst_format) {
3174 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003175 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003176 string_VkFormat(src_format), string_VkFormat(dst_format));
3177 }
3178 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003179 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003180 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003181 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003182 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003183 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003184 FormatElementSize(dst_format));
3185 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003186 }
3187 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003188
Dave Houlton33c22b72017-02-28 13:16:02 -07003189 // Source and dest image sample counts must match
3190 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003191 std::stringstream ss;
3192 ss << func_name << " called on image pair with non-identical sample counts.";
Tony-LunarGb61514a2021-11-02 12:36:51 -06003193 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003194 skip |=
3195 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3196 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3197 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003198 }
3199
sfricke-samsung45996a42021-09-16 13:45:27 -07003200 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003201 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3202 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003203 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003204 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003205 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3206 : (is_2 ? "VUID-VkCopyImageInfo2-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003207 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003208 // Validate that SRC & DST images have correct usage flags set
Tony-LunarGb61514a2021-11-02 12:36:51 -06003209 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003210 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003211 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003212 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003213 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003214 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003215 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003216 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003217 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003218 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003219 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003220 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003221
3222 // Validation for VK_EXT_fragment_density_map
3223 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003224 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003225 skip |=
3226 LogError(command_buffer, vuid,
3227 "%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 +02003228 }
3229 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003230 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003231 skip |=
3232 LogError(command_buffer, vuid,
3233 "%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 +02003234 }
3235
sfricke-samsung45996a42021-09-16 13:45:27 -07003236 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003237 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3238 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
3239 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3240 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003241 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003242 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003243 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003244
3245 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003246 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003247 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3248 : (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
Jeff Leger178b1e52020-10-05 12:22:23 -04003249 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003250 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003251 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3252 : (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
Jeff Leger178b1e52020-10-05 12:22:23 -04003253
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003254 for (uint32_t i = 0; i < regionCount; ++i) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003255 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003256 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003257 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003258 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003259 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003260 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003261 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
Tony-LunarGb61514a2021-11-02 12:36:51 -06003262 &pRegions[i], i, func_name, cmd_type);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003263 }
3264
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003265 return skip;
3266}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003267
Jeff Leger178b1e52020-10-05 12:22:23 -04003268bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3269 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3270 const VkImageCopy *pRegions) const {
3271 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003272 CMD_COPYIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003273}
3274
3275bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3276 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3277 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003278 CMD_COPYIMAGE2KHR);
3279}
3280
3281bool CoreChecks::PreCallValidateCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) const {
3282 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3283 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3284 CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003285}
3286
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003287void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3288 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3289 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003290 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3291 pRegions);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003292 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003293 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3294 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003295
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003296 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003297 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003298 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3299 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003300 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003301}
3302
Tony-LunarGb61514a2021-11-02 12:36:51 -06003303void CoreChecks::RecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003304 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003305 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3306 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003307
3308 // Make sure that all image slices are updated to correct layout
3309 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003310 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3311 pCopyImageInfo->srcImageLayout);
3312 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3313 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003314 }
3315}
3316
Tony-LunarGb61514a2021-11-02 12:36:51 -06003317void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3318 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3319 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3320}
3321
3322void CoreChecks::PreCallRecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
3323 StateTracker::PreCallRecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3324 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3325}
3326
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003327// Returns true if sub_rect is entirely contained within rect
3328static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3329 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 -07003330 (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 -07003331 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003332 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003333 return true;
3334}
3335
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003336bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003337 const IMAGE_VIEW_STATE* image_view_state,
3338 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003339 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003340
3341 for (uint32_t j = 0; j < rect_count; j++) {
3342 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003343 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003344 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3345 "the current render pass instance.",
3346 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003347 }
3348
3349 if (image_view_state) {
3350 // The layers specified by a given element of pRects must be contained within every attachment that
3351 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003352 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003353 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3354 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003355 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003356 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3357 "of pAttachment[%d].",
3358 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003359 }
3360 }
3361 }
3362 return skip;
3363}
3364
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003365bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3366 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003367 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003368 bool skip = false;
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003369 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Petr Kraus2dffb382019-08-10 02:52:12 +02003370 if (!cb_node) return skip;
3371
Jeremy Gebben9f537102021-10-05 16:37:12 -06003372 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003373
3374 // Validate that attachment is in reference list of active subpass
3375 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003376 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003377 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003378 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003379 const auto *framebuffer = cb_node->activeFramebuffer.get();
Aaron Hagan1656b2b2021-12-21 11:52:41 -05003380 const auto &render_area = (cb_node->activeRenderPass->use_dynamic_rendering) ?
3381 cb_node->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea :
3382 cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003383
John Zulauf3a548ef2019-02-01 16:14:07 -07003384 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3385 auto clear_desc = &pAttachments[attachment_index];
3386 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003387 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003388
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003389 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3390 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3391 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3392 attachment_index);
3393 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3394 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3395 skip |=
3396 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3397 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3398 attachment_index);
3399 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003400 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003401 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003402 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3403 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3404 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3405 skip |= LogError(
3406 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3407 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3408 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3409 attachment_index, clear_desc->colorAttachment,
3410 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3411 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003412
amhagana448ea52021-11-02 14:09:14 -04003413 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3414 }
3415 } else {
3416 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3417 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3418 " subpass %u. colorAttachmentCount=%u",
3419 attachment_index, clear_desc->colorAttachment,
3420 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3421 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003422 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003423 }
John Zulauff2582972019-02-09 14:53:30 -07003424 fb_attachment = color_attachment;
3425
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003426 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3427 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3428 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3429 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3430 "of a color attachment.",
3431 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003432 }
3433 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003434 bool subpass_depth = false;
3435 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003436 if (subpass_desc) {
3437 if (subpass_desc->pDepthStencilAttachment &&
3438 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3439 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3440 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3441 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003442 }
amhagana448ea52021-11-02 14:09:14 -04003443 if (!subpass_desc->pDepthStencilAttachment ||
3444 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3445 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3446 skip |= LogError(
3447 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3448 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3449 "depth attachment in subpass",
3450 attachment_index);
3451 }
3452 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003453 skip |= LogError(
3454 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3455 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003456 "stencil attachment in subpass",
3457 attachment_index);
3458 }
3459 } else {
3460 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003461 }
amhagana448ea52021-11-02 14:09:14 -04003462 if (subpass_depth) {
3463 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3464 "vkCmdClearAttachments()");
3465 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003466 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003467 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003468 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003469 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3470 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3471 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3472 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003473 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003474 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003475 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003476
3477 // Once the framebuffer attachment is found, can get the image view state
3478 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3479 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003480 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003481 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003482 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003483 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003484 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003485 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3486 }
3487 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003488
amhagana448ea52021-11-02 14:09:14 -04003489 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3490 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3491 for (uint32_t i = 0; i < rectCount; ++i) {
3492 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3493 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3494 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3495 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3496 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3497 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003498 }
3499 }
3500 }
John Zulauf441558b2019-08-12 11:47:39 -06003501 }
3502 return skip;
3503}
3504
3505void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3506 const VkClearAttachment *pAttachments, uint32_t rectCount,
3507 const VkClearRect *pRects) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003508 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003509 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003510 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003511 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3512 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3513 const auto clear_desc = &pAttachments[attachment_index];
3514 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3515 int image_index = -1;
3516 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3517 (clear_desc->colorAttachment < colorAttachmentCount)) {
3518 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3519 }
3520 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3521 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3522 }
3523 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3524 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3525 }
amhagana448ea52021-11-02 14:09:14 -04003526
Aaron Haganc6bafff2021-11-29 23:30:07 -05003527 if (image_index != -1) {
3528 if (!clear_rect_copy) {
3529 // We need a copy of the clear rectangles that will persist until the last lambda executes
3530 // but we want to create it as lazily as possible
3531 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003532 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003533 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3534 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3535 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3536 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3537 const FRAMEBUFFER_STATE *fb) {
3538 assert(rectCount == clear_rect_copy->size());
3539 bool skip = false;
3540 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3541 if (image_index != -1) {
3542 image_view_state = (*prim_cb->active_attachments)[image_index];
3543 }
3544 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3545 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3546 rectCount, clear_rect_copy->data());
3547 return skip;
3548 };
3549 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003550 }
amhagana448ea52021-11-02 14:09:14 -04003551 }
3552 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003553 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003554 {
3555 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3556 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003557
amhagana448ea52021-11-02 14:09:14 -04003558 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3559 const auto clear_desc = &pAttachments[attachment_index];
3560 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3561 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3562 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3563 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3564 }
3565 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3566 subpass_desc->pDepthStencilAttachment) {
3567 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3568 }
3569 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3570 if (!clear_rect_copy) {
3571 // We need a copy of the clear rectangles that will persist until the last lambda executes
3572 // but we want to create it as lazily as possible
3573 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3574 }
3575 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3576 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003577 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3578 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3579 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003580 assert(rectCount == clear_rect_copy->size());
3581 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3582 bool skip = false;
3583 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3584 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3585 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3586 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003587 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3588 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003589 return skip;
3590 };
3591 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3592 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003593 }
3594 }
3595 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003596}
3597
Jeff Leger178b1e52020-10-05 12:22:23 -04003598template <typename RegionType>
3599bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3600 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3601 const RegionType *pRegions, CopyCommandVersion version) const {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003602 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003603 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
3604 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003605 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003606 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE2KHR : CMD_RESOLVEIMAGE;
3607 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003608 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003609
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003610 bool skip = false;
3611 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003612 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003613 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003614 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003615 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3616 skip |= ValidateCmd(cb_node.get(), cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003617 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
Lionel Landwerlin21719f62021-12-09 11:40:09 +02003618 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_COLOR_ATTACHMENT_BIT_KHR, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003619 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003620 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003621 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003622 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003623 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003624 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003625
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003626 // Validation for VK_EXT_fragment_density_map
3627 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003628 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003629 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003630 "%s: srcImage must not have been created with flags containing "
3631 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3632 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003633 }
3634 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003635 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003636 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003637 "%s: dstImage must not have been created with flags containing "
3638 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3639 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003640 }
3641
Cort Stratton7df30962018-05-17 19:45:57 -07003642 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003643 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003644 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003645 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003646 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003647 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003648 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3649 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003650 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003651 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003652 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3653 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003654 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003655 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3656 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003657 // For each region, the number of layers in the image subresource should not be zero
3658 // For each region, src and dest image aspect must be color only
3659 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003660 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003661 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3662 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeremy Gebben9f537102021-10-05 16:37:12 -06003663 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3664 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04003665 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003666 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003667 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3668 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003669 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003670 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3671 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003672 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3673 "srcSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003674 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003675 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3676 "dstSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003677 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003678 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003679 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3680 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003681 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003682 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003683
3684 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003685 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003686 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3687 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003688 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003689 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003690 }
Cort Stratton7df30962018-05-17 19:45:57 -07003691 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003692 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3693 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003694 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003695 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003696 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3697 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003698 }
3699
3700 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3701 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3702
3703 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003704 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003705 LogObjectList objlist(cb_node->commandBuffer());
3706 objlist.add(src_image_state->image());
3707 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003708 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3709 skip |= LogError(objlist, vuid,
3710 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003711 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003712 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003713 }
3714 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003715 LogObjectList objlist(cb_node->commandBuffer());
3716 objlist.add(src_image_state->image());
3717 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003718 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3719 skip |= LogError(objlist, vuid,
3720 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003721 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003722 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003723 }
3724 }
3725
3726 if (VK_IMAGE_TYPE_1D == src_image_type) {
3727 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003728 LogObjectList objlist(cb_node->commandBuffer());
3729 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003730 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3731 skip |= LogError(objlist, vuid,
3732 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003733 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003734 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003735 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003736 }
3737 }
3738 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3739 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003740 LogObjectList objlist(cb_node->commandBuffer());
3741 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003742 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3743 skip |= LogError(objlist, vuid,
3744 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003745 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003746 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003747 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003748 }
3749 }
3750
3751 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3752 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003753 LogObjectList objlist(cb_node->commandBuffer());
3754 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003755 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3756 skip |= LogError(objlist, vuid,
3757 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003758 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003759 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003760 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003761 }
3762 }
3763 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3764 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003765 LogObjectList objlist(cb_node->commandBuffer());
3766 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003767 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3768 skip |= LogError(objlist, vuid,
3769 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003770 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003771 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003773 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003774 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003775
3776 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003777 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003778 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3779 // developer
3780 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3781 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003782 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003783 LogObjectList objlist(cb_node->commandBuffer());
3784 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003785 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3786 skip |= LogError(objlist, vuid,
3787 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003788 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003789 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003790 region.extent.width, subresource_extent.width);
3791 }
3792
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003793 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003794 LogObjectList objlist(cb_node->commandBuffer());
3795 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003796 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3797 skip |= LogError(objlist, vuid,
3798 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003799 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003800 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003801 region.extent.height, subresource_extent.height);
3802 }
3803
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003804 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003805 LogObjectList objlist(cb_node->commandBuffer());
3806 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003807 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3808 skip |= LogError(objlist, vuid,
3809 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003810 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003811 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003812 region.extent.depth, subresource_extent.depth);
3813 }
3814 }
3815
3816 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003817 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003818 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3819 // developer
3820 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3821 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003822 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003823 LogObjectList objlist(cb_node->commandBuffer());
3824 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003825 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3826 skip |= LogError(objlist, vuid,
3827 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003828 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003829 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003830 region.extent.width, subresource_extent.width);
3831 }
3832
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003833 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003834 LogObjectList objlist(cb_node->commandBuffer());
3835 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003836 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3837 skip |= LogError(objlist, vuid,
3838 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003839 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003840 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003841 region.extent.height, subresource_extent.height);
3842 }
3843
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003844 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003845 LogObjectList objlist(cb_node->commandBuffer());
3846 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003847 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3848 skip |= LogError(objlist, vuid,
3849 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003850 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003851 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003852 region.extent.depth, subresource_extent.depth);
3853 }
3854 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003855 }
3856
3857 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003858 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003859 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 -04003860 func_name, string_VkFormat(src_image_state->createInfo.format),
3861 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003862 }
3863 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003864 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003865 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003866 string_VkImageType(src_image_state->createInfo.imageType),
3867 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003868 }
3869 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003870 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003871 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 -07003872 }
3873 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003874 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003875 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 -04003876 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003877 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003878 } else {
3879 assert(0);
3880 }
3881 return skip;
3882}
3883
Jeff Leger178b1e52020-10-05 12:22:23 -04003884bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3885 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3886 const VkImageResolve *pRegions) const {
3887 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3888 COPY_COMMAND_VERSION_1);
3889}
3890
3891bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3892 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3893 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3894 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3895 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3896}
3897
3898template <typename RegionType>
3899bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3900 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3901 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003902 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003903 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
3904 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003905
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003907 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE2KHR : CMD_BLITIMAGE;
3908 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003909
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003910 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003911 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003912 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07003913 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003914 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003915 const char *vuid;
3916 const char *location;
3917 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3918 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003919 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003920 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3921 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003922 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003923 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003924 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003925 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003926 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003927 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003928 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3930 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003931 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003932 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003933 skip |= ValidateCmd(cb_node.get(), cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003934 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
Lionel Landwerlin21719f62021-12-09 11:40:09 +02003935 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_SRC_BIT_KHR, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003936 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
Lionel Landwerlin21719f62021-12-09 11:40:09 +02003937 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_DST_BIT_KHR, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003938 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003939 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003941 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003943 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003944
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003945 // Validation for VK_EXT_fragment_density_map
3946 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003947 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003948 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003949 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3950 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003951 }
3952 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003953 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003954 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003955 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3956 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003957 }
3958
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003959 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003960
Dave Houlton33c2d252017-06-09 17:08:32 -06003961 VkFormat src_format = src_image_state->createInfo.format;
3962 VkFormat dst_format = dst_image_state->createInfo.format;
3963 VkImageType src_type = src_image_state->createInfo.imageType;
3964 VkImageType dst_type = dst_image_state->createInfo.imageType;
3965
Cort Stratton186b1a22018-05-01 20:18:06 -04003966 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003967 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
Lionel Landwerlin21719f62021-12-09 11:40:09 +02003968 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(),
3969 VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_LINEAR_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06003970 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003971 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003972 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Lionel Landwerlin21719f62021-12-09 11:40:09 +02003973 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(),
3974 VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT,
Jeff Leger178b1e52020-10-05 12:22:23 -04003975 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003976 }
3977
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003978 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003979 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04003980 skip |= LogError(device, vuid,
3981 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003982 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003983 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003984 }
3985
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003986 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003987 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04003988 skip |= LogError(device, vuid,
3989 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003990 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003991 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003992 }
3993
ziga-lunarg52604a12021-09-09 16:02:05 +02003994 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003995 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003996 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02003997 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003998 }
3999
Dave Houlton33c2d252017-06-09 17:08:32 -06004000 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004001 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004002 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004003 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004004 << "the other one must also have unsigned integer format. "
4005 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004006 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004007 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004008 }
4009
4010 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004011 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004012 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004013 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004014 << "the other one must also have signed integer format. "
4015 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004016 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004017 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004018 }
4019
4020 // Validate filter for Depth/Stencil formats
4021 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4022 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004023 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004024 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04004025 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004026 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004027 }
4028
4029 // Validate aspect bits and formats for depth/stencil images
4030 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4031 if (src_format != dst_format) {
4032 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004033 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 -06004034 << "stencil, the other one must have exactly the same format. "
4035 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4036 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004038 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004039 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004040 } // Depth or Stencil
4041
4042 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004043 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004044 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004045 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4046 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004047 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004048 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4049 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004050 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004051 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004052 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4053 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004054 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004055 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4056 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004057 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004058 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004059 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004060 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004061 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004062 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4063 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004064 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004065 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06004066 skip |= ValidateImageSubresourceLayers(cb_node.get(), &rgn.srcSubresource, func_name, "srcSubresource", i);
4067 skip |= ValidateImageSubresourceLayers(cb_node.get(), &rgn.dstSubresource, func_name, "dstSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04004068 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004069 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), rgn.srcSubresource.mipLevel, i, func_name,
4070 "srcSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04004071 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004072 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), rgn.dstSubresource.mipLevel, i, func_name,
4073 "dstSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04004074 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004075 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004076 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4077 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004078 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004079 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004080 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004081 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4082 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004083 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004084 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004085 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004086 }
Dave Houlton48989f32017-05-26 15:01:46 -06004087 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4088 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004089 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004090 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004091 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004092 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004093
4094 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004095 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004096 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4097 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004098 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004099 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004100 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004101
Dave Houlton48989f32017-05-26 15:01:46 -06004102 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004103 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4104 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004105 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004106 }
Dave Houlton48989f32017-05-26 15:01:46 -06004107
Dave Houlton33c2d252017-06-09 17:08:32 -06004108 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004109 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004110 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004111 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004112 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004113 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004114 }
4115
4116 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004117 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004118 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004119 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4120 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004121 }
4122
Dave Houlton48989f32017-05-26 15:01:46 -06004123 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004124 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004125 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004126 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004127 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
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], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4130 "of (%1d, %1d). These must be (0, 1).",
4131 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004132 }
4133 }
4134
Dave Houlton33c2d252017-06-09 17:08:32 -06004135 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004136 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004137 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004138 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004139 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4140 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4141 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004142 }
4143 }
4144
Dave Houlton33c2d252017-06-09 17:08:32 -06004145 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004146 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4147 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004148 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004149 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004150 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004151 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4152 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004153 }
4154 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4155 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004156 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004157 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004158 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004159 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4160 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004161 }
4162 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4163 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004164 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004165 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004166 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004167 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4168 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004169 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004170 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004171 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004172 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004173 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004174 }
Dave Houlton48989f32017-05-26 15:01:46 -06004175
4176 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004177 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004178 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004179 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004180 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
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], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4183 "(%1d, %1d). These must be (0, 1).",
4184 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004185 }
4186 }
4187
Dave Houlton33c2d252017-06-09 17:08:32 -06004188 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004189 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004190 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004191 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004192 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004193 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004194 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004195 }
4196 }
4197
Dave Houlton33c2d252017-06-09 17:08:32 -06004198 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004199 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4200 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004201 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004202 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
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] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4205 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004206 }
4207 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4208 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004209 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004210 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004211 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004212 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4213 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004214 }
4215 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4216 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004217 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004218 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004219 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004220 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4221 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004222 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004223 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004224 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004225 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004226 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004227 }
4228
Dave Houlton33c2d252017-06-09 17:08:32 -06004229 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4230 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4231 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004232 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004233 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004234 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4235 "layerCount other than 1.",
4236 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004237 }
4238 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004239 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004240 } else {
4241 assert(0);
4242 }
4243 return skip;
4244}
4245
Jeff Leger178b1e52020-10-05 12:22:23 -04004246bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4247 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4248 const VkImageBlit *pRegions, VkFilter filter) const {
4249 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4250 COPY_COMMAND_VERSION_1);
4251}
4252
4253bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4254 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4255 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4256 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4257}
4258
4259template <typename RegionType>
4260void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4261 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4262 VkFilter filter) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07004263 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004264 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4265 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004266
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004267 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004268 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004269 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4270 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004271 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004272}
4273
Jeff Leger178b1e52020-10-05 12:22:23 -04004274void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4275 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4276 const VkImageBlit *pRegions, VkFilter filter) {
4277 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4278 pRegions, filter);
4279 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4280}
4281
4282void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4283 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4284 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4285 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4286 pBlitImageInfo->filter);
4287}
4288
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004289GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004290 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004291 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004292 if (!layout_map) {
4293 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004294 }
John Zulauf17708d02021-02-22 11:20:58 -07004295 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004296}
4297
Jeremy Gebben6335df62021-11-01 10:50:13 -06004298const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4299 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004300 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004301 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004302 }
4303 return nullptr;
4304}
4305
Jeremy Gebben53631302021-04-13 16:46:37 -06004306// Helper to update the Global or Overlay layout map
4307struct GlobalLayoutUpdater {
4308 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4309 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4310 dst = src.current_layout;
4311 return true;
4312 }
4313 return false;
4314 }
4315
4316 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4317 layer_data::optional<VkImageLayout> result;
4318 if (src.current_layout != image_layout_map::kInvalidLayout) {
4319 result.emplace(src.current_layout);
4320 }
4321 return result;
4322 }
4323};
4324
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004325// 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 -07004326bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004327 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004328 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004329 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004330 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004331 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004332 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004333 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004334 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004335 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004336 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004337 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004338
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004339 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004340 const auto *global_map = image_state->layout_range_map.get();
4341 assert(global_map);
4342 auto global_map_guard = global_map->ReadLock();
John Zulauf2076e812020-01-08 14:55:54 -07004343
4344 // Note: don't know if it would matter
4345 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4346
Jeremy Gebben53631302021-04-13 16:46:37 -06004347 auto pos = layout_map.begin();
4348 const auto end = layout_map.end();
4349 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4350 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004351 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004352 VkImageLayout initial_layout = pos->second.initial_layout;
4353 assert(initial_layout != image_layout_map::kInvalidLayout);
4354 if (initial_layout == image_layout_map::kInvalidLayout) {
4355 continue;
4356 }
4357
John Zulauf2076e812020-01-08 14:55:54 -07004358 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004359
John Zulauf2076e812020-01-08 14:55:54 -07004360 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 -07004361 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004362 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004363 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004364 image_layout = current_layout->pos_B->lower_bound->second;
4365 }
4366 const auto intersected_range = pos->first & current_layout->range;
4367 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4368 // TODO: Set memory invalid which is in mem_tracker currently
4369 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004370 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4371 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004372 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004373 // We can report all the errors for the intersected range directly
4374 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004375 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004376 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004377 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004378 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004379 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004380 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004381 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004382 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004383 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004384 }
4385 }
John Zulauf2076e812020-01-08 14:55:54 -07004386 if (pos->first.includes(intersected_range.end)) {
4387 current_layout.seek(intersected_range.end);
4388 } else {
4389 ++pos;
4390 if (pos != end) {
4391 current_layout.seek(pos->first.begin);
4392 }
4393 }
John Zulauff660ad62019-03-23 07:16:05 -06004394 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004395 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004396 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004397 }
John Zulauff660ad62019-03-23 07:16:05 -06004398
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004399 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004400}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004401
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004402void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004403 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004404 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004405 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004406 auto guard = image_state->layout_range_map->WriteLock();
4407 sparse_container::splice(*image_state->layout_range_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004408 }
4409}
4410
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004411// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004412// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4413// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004414bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4415 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004416 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004417 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004418 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4419
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004420 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004421 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4422 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004423 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004424 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4425 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4426 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004427 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004428 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004429 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004430 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004431 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4432 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004433 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004434 string_VkImageLayout(first_layout));
4435 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4436 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004437 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004438 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004439 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004440 }
4441 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004442
4443 // Same as above for loadOp, but for stencilLoadOp
4444 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4445 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4446 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4447 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4448 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004449 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004450 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004451 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004452 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4453 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004454 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004455 string_VkImageLayout(first_layout));
4456 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4457 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4458 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004459 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004460 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004461 }
4462 }
4463
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004464 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004465}
4466
Mark Lobodzinski96210742017-02-09 10:33:46 -07004467// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4468// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004469template <typename T1>
4470bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4471 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4472 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004473 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004474 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004475 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004476 if (strict) {
4477 correct_usage = ((actual & desired) == desired);
4478 } else {
4479 correct_usage = ((actual & desired) != 0);
4480 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004481
Mark Lobodzinski96210742017-02-09 10:33:46 -07004482 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004483 // All callers should have a valid VUID
4484 assert(msgCode != kVUIDUndefined);
4485 skip =
4486 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4487 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004488 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004489 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004490}
4491
4492// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4493// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004494bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004495 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004496 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004497 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004498}
4499
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004500bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags2KHR desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004501 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004502 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004503 const VkFormatFeatureFlags2KHR image_format_features = image_state->format_features;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004504 if ((image_format_features & desired) != desired) {
4505 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004506 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004507 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004508 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for the external format "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004509 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004510 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004511 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004512 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004513 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004514 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for format %u used by %s "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004515 "with tiling %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004516 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004517 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004518 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004519 }
4520 }
4521 return skip;
4522}
4523
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004524bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004525 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004526 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004527 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004528 // layerCount must not be zero
4529 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004530 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004531 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004532 }
4533 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004534 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004535 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004536 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004537 }
4538 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004539 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 -06004540 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004541 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4542 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4543 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004544 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004545 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4546 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4547 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004548 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004549 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4550 member);
4551 }
Cort Strattond619a302018-05-17 19:46:32 -07004552 return skip;
4553}
4554
Mark Lobodzinski96210742017-02-09 10:33:46 -07004555// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4556// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004557bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004558 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004559 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004560 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004561}
4562
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004563bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004564 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004565 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004566
4567 const VkDeviceSize &range = pCreateInfo->range;
4568 if (range != VK_WHOLE_SIZE) {
4569 // Range must be greater than 0
4570 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004571 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004572 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004573 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4574 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004575 }
4576 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004577 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4578 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004579 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004580 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004581 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4582 "(%" PRIu32 ").",
4583 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004584 }
4585 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004586 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004587 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004588 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004589 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4590 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4591 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004592 }
4593 // The sum of range and offset must be less than or equal to the size of buffer
4594 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004595 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004596 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004597 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4598 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4599 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004600 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004601 } else {
4602 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4603
4604 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4605 // VkPhysicalDeviceLimits::maxTexelBufferElements
4606 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4607 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004608 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004609 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4610 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4611 "), divided by the element size of the format (%" PRIu32
4612 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4613 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4614 device_limits->maxTexelBufferElements);
4615 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004616 }
4617 return skip;
4618}
4619
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004620bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004621 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004622 const VkFormatProperties3KHR format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004623 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004624 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004625 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004626 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004627 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4628 "be supported for uniform texel buffers",
4629 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004630 }
4631 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004632 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_STORAGE_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004633 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004634 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004635 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4636 "be supported for storage texel buffers",
4637 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004638 }
4639 return skip;
4640}
4641
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004642bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004643 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004644 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004645
Dave Houltond8ed0212018-05-16 17:18:24 -06004646 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004647
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004648 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004649 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004650 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004651 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004652 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4653 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004654 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004655 }
4656 }
4657
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004658 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004659 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004660 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004661 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004662 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004663 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4664 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004665 }
4666 }
4667
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004668 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4669 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4670 if (pCreateInfo->flags &
4671 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4672 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4673 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4674 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4675 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4676 }
4677 }
4678
Mike Schuchardt2df08912020-12-15 16:28:09 -08004679 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004680 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004681 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004682 skip |= LogError(
4683 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004684 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004685 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004686 }
4687
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004688 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004689 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4690 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4691 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004692 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004693 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004694 }
4695
sfricke-samsungedce77a2020-07-03 22:35:13 -07004696 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4697 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4698 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4699 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4700 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4701 }
4702 const VkBufferCreateFlags invalid_flags =
4703 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4704 if ((pCreateInfo->flags & invalid_flags) != 0) {
4705 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4706 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4707 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4708 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4709 }
4710 }
4711
Mark Lobodzinski96210742017-02-09 10:33:46 -07004712 return skip;
4713}
4714
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004715bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004716 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004717 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004718 const auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004719
4720 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4721 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4722 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4723 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4724 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4725 "defined sizes for alignment, replace with a color format.",
4726 string_VkFormat(pCreateInfo->format));
4727 }
4728
Mark Lobodzinski96210742017-02-09 10:33:46 -07004729 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4730 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004731 skip |=
4732 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004733 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4734 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06004735 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06004736 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4737 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4738 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004739
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004740 // Buffer view offset must be less than the size of buffer
4741 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004742 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004743 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004744 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4745 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004746 }
4747
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004748 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004749 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4750 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4751 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004752 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4753 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4754 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004755 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004756 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004757 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4758 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004759 }
4760
4761 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004762 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4763 if ((element_size % 3) == 0) {
4764 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004765 }
4766 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004767 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004768 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4769 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004770 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004771 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004772 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004773 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004774 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004775 "vkCreateBufferView(): If buffer was created with usage containing "
4776 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004777 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4778 ") must be a multiple of the lesser of "
4779 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4780 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4781 "(%" PRId32
4782 ") is VK_TRUE, the size of a texel of the requested format. "
4783 "If the size of a texel is a multiple of three bytes, then the size of a "
4784 "single component of format is used instead",
4785 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4786 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4787 }
4788 }
4789 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004790 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004791 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4792 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004793 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004794 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004795 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004796 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004797 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004798 "vkCreateBufferView(): If buffer was created with usage containing "
4799 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004800 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4801 ") must be a multiple of the lesser of "
4802 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4803 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4804 "(%" PRId32
4805 ") is VK_TRUE, the size of a texel of the requested format. "
4806 "If the size of a texel is a multiple of three bytes, then the size of a "
4807 "single component of format is used instead",
4808 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4809 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4810 }
4811 }
4812 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004813
Jeremy Gebben9f537102021-10-05 16:37:12 -06004814 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004815
Jeremy Gebben9f537102021-10-05 16:37:12 -06004816 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004817 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004818 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004819}
4820
Mark Lobodzinski602de982017-02-09 11:01:33 -07004821// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004822bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004823 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004824 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004825 const auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung79b00482020-04-01 21:15:50 -07004826 // checks color format and (single-plane or non-disjoint)
4827 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004828 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004829 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004830 skip |= LogError(
4831 image, vuid,
4832 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4833 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004834 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004835 skip |= LogError(image, vuid,
4836 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4837 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4838 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004839 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004840 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004841 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004842 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004843 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4844 "of VK_IMAGE_ASPECT_DEPTH_BIT and 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 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004847 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004848 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4849 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4850 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004851 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004852 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004853 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004854 skip |= LogError(image, vuid,
4855 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4856 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4857 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004858 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004859 skip |= LogError(image, vuid,
4860 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4861 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4862 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004863 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004864 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004865 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004866 skip |= LogError(image, vuid,
4867 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4868 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4869 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004870 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004871 skip |= LogError(image, vuid,
4872 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4873 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4874 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004875 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004876 } else if (FormatIsMultiplane(format)) {
4877 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4878 if (3 == FormatPlaneCount(format)) {
4879 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4880 }
4881 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004882 skip |= LogError(image, vuid,
4883 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4884 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4885 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004886 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004887 }
4888 return skip;
4889}
4890
ziga-lunarg04e94b32021-10-03 01:42:37 +02004891bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
4892 bool skip = false;
4893
ziga-lunarg04e94b32021-10-03 01:42:37 +02004894 return skip;
4895}
4896
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004897bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4898 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004899 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004900 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004901 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004902
4903 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004904 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004905 skip |= LogError(image, errorCodes.base_mip_err,
4906 "%s: %s.baseMipLevel (= %" PRIu32
4907 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4908 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004909 }
Petr Kraus4d718682017-05-18 03:38:41 +02004910
Petr Krausffa94af2017-08-08 21:46:02 +02004911 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4912 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004913 skip |=
4914 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004915 } else {
4916 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004917
Petr Krausffa94af2017-08-08 21:46:02 +02004918 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004919 skip |= LogError(image, errorCodes.mip_count_err,
4920 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4921 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4922 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4923 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004924 }
Petr Kraus4d718682017-05-18 03:38:41 +02004925 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004926 }
Petr Kraus4d718682017-05-18 03:38:41 +02004927
4928 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004929 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004930 skip |= LogError(image, errorCodes.base_layer_err,
4931 "%s: %s.baseArrayLayer (= %" PRIu32
4932 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4933 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004934 }
Petr Kraus4d718682017-05-18 03:38:41 +02004935
Petr Krausffa94af2017-08-08 21:46:02 +02004936 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4937 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004938 skip |=
4939 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004940 } else {
4941 const uint64_t necessary_layer_count =
4942 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004943
Petr Krausffa94af2017-08-08 21:46:02 +02004944 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004945 skip |= LogError(image, errorCodes.layer_count_err,
4946 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4947 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4948 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4949 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004950 }
Petr Kraus4d718682017-05-18 03:38:41 +02004951 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004952 }
Petr Kraus4d718682017-05-18 03:38:41 +02004953
ziga-lunargb4e90752021-08-02 13:58:29 +02004954 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4955 if (subresourceRange.aspectMask &
4956 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4957 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4958 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4959 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4960 cmd_name);
4961 }
4962 }
4963
Mark Lobodzinski602de982017-02-09 11:01:33 -07004964 return skip;
4965}
4966
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004967bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004968 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004969 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004970 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004971 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004972 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 +02004973
David McFarland2853f2f2020-11-30 15:50:39 -04004974 uint32_t image_layer_count;
4975
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004976 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004977 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004978 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004979 image_layer_count = extent.depth;
4980 } else {
4981 image_layer_count = image_state->createInfo.arrayLayers;
4982 }
4983
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004984 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004985
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004986 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4987 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4988 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4989 subresource_range_error_codes.base_layer_err =
4990 is_khr_maintenance1
4991 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4992 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4993 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4994 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4995 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4996 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004997
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004998 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004999 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005000 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005001}
5002
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005003bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005004 const VkImageSubresourceRange &subresourceRange,
5005 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005006 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5007 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5008 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5009 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5010 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005011
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005012 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005013 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005014 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005015}
5016
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005017bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005018 const VkImageSubresourceRange &subresourceRange,
5019 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005020 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5021 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5022 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5023 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5024 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005025
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005026 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005027 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005028 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005029}
5030
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005031bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005032 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005033 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005034 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005035 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005036}
5037
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005038namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005039using sync_vuid_maps::GetBarrierQueueVUID;
5040using sync_vuid_maps::kQueueErrorSummary;
5041using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005042
5043class ValidatorState {
5044 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005045 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005046 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5047 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005048 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005049 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005050 barrier_handle_(barrier_handle),
5051 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005052 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5053 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5054
5055 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5056 // 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 -07005057 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5058 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005059 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005060 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5061 loc_.Message().c_str(), GetTypeString(),
5062 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5063 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005064 }
5065
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005066 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5067 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005068 const char *src_annotation = GetFamilyAnnotation(src_family);
5069 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5070 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005071 objects_, val_code,
5072 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5073 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5074 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005075 }
5076
5077 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5078 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5079 // application input.
5080 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5081 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005082 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005083 uint32_t queue_family = queue_state->queueFamilyIndex;
5084 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005085 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005086 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5087 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5088 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005089 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005090 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005091 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005092 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005093 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005094 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005095 }
5096 return false;
5097 }
5098 // Logical helpers for semantic clarity
5099 inline bool KhrExternalMem() const { return mem_ext_; }
5100 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5101 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5102 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5103 }
5104
5105 // Helpers for LogMsg
5106 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5107
5108 // Descriptive text for the various types of queue family index
5109 const char *GetFamilyAnnotation(uint32_t family) const {
5110 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5111 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5112 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5113 const char *valid = " (VALID)";
5114 const char *invalid = " (INVALID)";
5115 switch (family) {
5116 case VK_QUEUE_FAMILY_EXTERNAL:
5117 return external;
5118 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5119 return foreign;
5120 case VK_QUEUE_FAMILY_IGNORED:
5121 return ignored;
5122 default:
5123 if (IsValid(family)) {
5124 return valid;
5125 }
5126 return invalid;
5127 };
5128 }
5129 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5130 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5131
5132 protected:
5133 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005134 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005135 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005136 const VulkanTypedHandle barrier_handle_;
5137 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005138 const uint32_t limit_;
5139 const bool mem_ext_;
5140};
5141
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005142bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005143 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5144 bool skip = false;
5145
5146 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5147 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5148 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5149 if (val.KhrExternalMem()) {
5150 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005151 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005152 // this requirement is removed by VK_KHR_synchronization2
5153 if (!(src_ignored || dst_ignored) && !sync2) {
5154 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005155 }
5156 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5157 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005158 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005159 }
5160 } else {
5161 // VK_SHARING_MODE_EXCLUSIVE
5162 if (src_queue_family != dst_queue_family) {
5163 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005164 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005165 }
5166 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005167 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005168 }
5169 }
5170 }
5171 } else {
5172 // No memory extension
5173 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005174 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005175 // this requirement is removed by VK_KHR_synchronization2
5176 if ((!src_ignored || !dst_ignored) && !sync2) {
5177 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005178 }
5179 } else {
5180 // VK_SHARING_MODE_EXCLUSIVE
5181 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005182 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005183 }
5184 }
5185 }
5186 return skip;
5187}
5188} // namespace barrier_queue_families
5189
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005190bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5191 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005192 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5193 uint32_t dst_queue_family) {
5194 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005195 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5196 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005197}
5198
5199// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005200template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005201bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5202 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005203 // State data is required
5204 if (!state_data) {
5205 return false;
5206 }
5207
5208 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005209 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005210 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005211 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5212 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005213 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005214}
5215
5216// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005217template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005218bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5219 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005220 // State data is required
5221 if (!state_data) {
5222 return false;
5223 }
5224
5225 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005226 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005227 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005228 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5229 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005230 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5231}
5232
5233template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005234bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005235 const Barrier &mem_barrier) const {
5236 using sync_vuid_maps::BufferError;
5237 using sync_vuid_maps::GetBufferBarrierVUID;
5238
5239 bool skip = false;
5240
5241 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5242
5243 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005244 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005245 if (buffer_state) {
5246 auto buf_loc = loc.dot(Field::buffer);
5247 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005248 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005249
Jeremy Gebben9f537102021-10-05 16:37:12 -06005250 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005251
5252 auto buffer_size = buffer_state->createInfo.size;
5253 if (mem_barrier.offset >= buffer_size) {
5254 auto offset_loc = loc.dot(Field::offset);
5255 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5256
5257 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5258 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5259 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5260 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5261 auto size_loc = loc.dot(Field::size);
5262 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5263 skip |= LogError(objects, vuid,
5264 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5265 ".",
5266 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5267 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5268 }
5269 if (mem_barrier.size == 0) {
5270 auto size_loc = loc.dot(Field::size);
5271 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5272 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5273 report_data->FormatHandle(mem_barrier.buffer).c_str());
5274 }
5275 }
5276 return skip;
5277}
5278
5279template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005280bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005281 const Barrier &mem_barrier) const {
5282 bool skip = false;
5283
5284 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5285
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005286 bool is_ilt = true;
Tony-LunarG273f32f2021-09-28 08:56:30 -06005287 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005288 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5289 }
5290
5291 if (is_ilt) {
5292 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5293 auto layout_loc = loc.dot(Field::newLayout);
5294 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5295 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005296 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005297 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005298 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005299 }
5300
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005301 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005302 if (image_data) {
5303 auto image_loc = loc.dot(Field::image);
5304
Jeremy Gebben9f537102021-10-05 16:37:12 -06005305 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005306
Jeremy Gebben9f537102021-10-05 16:37:12 -06005307 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005308
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005309 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005310 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005311
Jeremy Gebben9f537102021-10-05 16:37:12 -06005312 skip |=
5313 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg04e94b32021-10-03 01:42:37 +02005314 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005315 }
5316 return skip;
5317}
5318
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005319bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5320 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5321 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005322 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5323 const VkImageMemoryBarrier *pImageMemBarriers) const {
5324 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005325 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005326
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005327 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5328 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005329 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005330 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005331 }
5332 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5333 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005334 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005335 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005336 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5337 }
5338 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005339 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005340 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5341 }
5342 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5343 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005344 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005345 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005346 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5347 }
5348 return skip;
5349}
5350
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005351bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005352 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005353 bool skip = false;
5354
5355 if (cb_state->activeRenderPass) {
5356 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5357 if (skip) return true; // Early return to avoid redundant errors from below calls
5358 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005359 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5360 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005361 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005362 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005363 }
5364 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5365 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005366 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005367 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005368 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5369 }
5370 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005371 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005372 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5373 }
5374
5375 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5376 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005377 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005378 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005379 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5380 }
5381
5382 return skip;
5383}
5384
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005385// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005386template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005387bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5388 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005389 VkPipelineStageFlags dst_stage_mask) const {
5390 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005391 assert(cb_state);
5392 auto queue_flags = cb_state->GetQueueFlags();
5393
5394 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005395 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5396 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005397 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005398 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5399 }
5400 return skip;
5401}
5402
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005403// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005404template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005405bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5406 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005407 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005408 assert(cb_state);
5409 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005410
Jeremy Gebbenefead332021-06-18 08:22:44 -06005411 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005412 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005413 skip |=
5414 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5415 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005416
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005417 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005418 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005419 skip |=
5420 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5421 }
5422 return skip;
5423}
5424
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005425// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5426// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5427// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5428static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5429 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5430}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005431
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005432bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5433 const VkSubpassDependency2 &dependency) const {
5434 bool skip = false;
5435 Location loc = in_loc;
5436 VkMemoryBarrier2KHR converted_barrier;
5437 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5438
Tony-LunarG273f32f2021-09-28 08:56:30 -06005439 if (mem_barrier && enabled_features.core13.synchronization2) {
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005440 if (dependency.srcAccessMask != 0) {
5441 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5442 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5443 loc.dot(Field::srcAccessMask).Message().c_str());
5444 }
5445 if (dependency.dstAccessMask != 0) {
5446 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5447 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5448 loc.dot(Field::dstAccessMask).Message().c_str());
5449 }
5450 if (dependency.srcStageMask != 0) {
5451 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5452 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5453 loc.dot(Field::srcStageMask).Message().c_str());
5454 }
5455 if (dependency.dstStageMask != 0) {
5456 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5457 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5458 loc.dot(Field::dstStageMask).Message().c_str());
5459 }
5460 loc = in_loc.dot(Field::pNext);
5461 converted_barrier = *mem_barrier;
5462 } else {
5463 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005464 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5465 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5466 loc.Message().c_str());
5467 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005468 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5469 converted_barrier.srcStageMask = dependency.srcStageMask;
5470 converted_barrier.dstStageMask = dependency.dstStageMask;
5471 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5472 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005473 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005474 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5475 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5476 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5477 converted_barrier.srcStageMask);
5478
5479 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5480 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5481 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5482 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005483 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005484}
5485
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005486bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5487 const VkImageUsageFlags image_usage) const {
5488 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5489 bool skip = false;
5490
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005491 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005492 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5493
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005494 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005495 // AHB image view and image share same feature sets
5496 tiling_features = image_state->format_features;
5497 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5498 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005499 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005500 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5501 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005502 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005503
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005504 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
5505 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
5506 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005507
nyorain38a9d232021-03-06 13:06:12 +01005508 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005509 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
5510 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
nyorain38a9d232021-03-06 13:06:12 +01005511
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005512 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
nyorain38a9d232021-03-06 13:06:12 +01005513
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005514 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
5515 if (fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier == drm_format_properties.drmFormatModifier) {
5516 tiling_features = fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5517 break;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005518 }
5519 }
5520 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005521 VkFormatProperties3KHR format_properties = GetPDFormatProperties(view_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005522 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5523 : format_properties.optimalTilingFeatures;
5524 }
5525
5526 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005527 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005528 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5529 "physical device.",
5530 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5531 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005532 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005533 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5534 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5535 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5536 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005537 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005538 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5539 "VK_IMAGE_USAGE_STORAGE_BIT.",
5540 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5541 } 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 -06005542 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005543 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5544 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5545 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5546 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5547 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005548 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005549 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5550 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5551 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5552 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5553 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005554 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005555 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5556 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5557 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005558 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5559 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5560 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005561 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005562 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5563 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5564 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5565 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005566 }
5567
5568 return skip;
5569}
5570
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005571bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005572 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005573 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005574 const auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005575 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005576 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005577 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005578 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5579 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005580 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5581 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5582 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005583 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005584 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005585 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005586 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005587 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005588 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005589 image_state.get(),
5590 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005591 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005592
5593 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5594 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005595 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005596 VkFormat view_format = pCreateInfo->format;
5597 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005598 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005599 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005600 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005601
Dave Houltonbd2e2622018-04-10 16:41:14 -06005602 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005603 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005604 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005605 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5606 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005607 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005608 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5609 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5610 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005611 }
5612 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005613 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005614 if (image_stencil_struct == nullptr) {
5615 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005616 skip |= LogError(
5617 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005618 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5619 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5620 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5621 }
5622 } else {
5623 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5624 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5625 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005626 skip |= LogError(
5627 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005628 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5629 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5630 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5631 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5632 }
5633 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5634 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005635 skip |= LogError(
5636 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005637 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5638 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5639 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5640 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5641 }
5642 }
5643 }
5644 }
5645
Dave Houltonbd2e2622018-04-10 16:41:14 -06005646 image_usage = chained_ivuci_struct->usage;
5647 }
5648
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005649 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5650 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5651 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5652 bool foundFormat = false;
5653 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5654 if (format_list_info->pViewFormats[i] == view_format) {
5655 foundFormat = true;
5656 break;
5657 }
5658 }
5659 if (foundFormat == false) {
5660 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5661 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5662 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5663 string_VkFormat(view_format));
5664 }
5665 }
5666
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005667 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5668 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005669 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005670 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005671 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005672 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005673 std::stringstream ss;
5674 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005675 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005676 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005677 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005678 }
5679 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005680 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005681 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
sfricke-samsung965e5f82021-11-24 00:17:47 -06005682 auto image_class = FormatCompatibilityClass(image_format);
5683 auto view_class = FormatCompatibilityClass(view_format);
5684 // Need to only check if one is NONE to handle edge case both are NONE
5685 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005686 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005687 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5688 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005689 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005690 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5691 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005692 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005693 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5694 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005695 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5696 } else {
5697 // both enabled
5698 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5699 }
Dave Houltonc7988072018-04-16 11:46:56 -06005700 std::stringstream ss;
5701 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005702 << " is not in the same format compatibility class as "
5703 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005704 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5705 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005706 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005707 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005708 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005709 }
5710 } else {
5711 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005712 // Unless it is a multi-planar color bit aspect
5713 if ((image_format != view_format) &&
5714 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005715 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5716 ? "VUID-VkImageViewCreateInfo-image-01762"
5717 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005718 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005719 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005720 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005721 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005722 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005723 }
5724 }
5725
ziga-lunargebb32de2021-08-29 21:24:30 +02005726 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5727 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5728 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5729 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5730 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5731 }
5732
Mark Lobodzinski602de982017-02-09 11:01:33 -07005733 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005734 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005735
sfricke-samsung20a8a372021-07-14 06:12:17 -07005736 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005737 switch (image_type) {
5738 case VK_IMAGE_TYPE_1D:
5739 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005740 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5741 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5742 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005743 }
5744 break;
5745 case VK_IMAGE_TYPE_2D:
5746 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5747 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5748 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005749 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5750 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5751 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005752 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005753 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5754 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5755 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005756 }
5757 }
5758 break;
5759 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005760 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005761 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5762 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005763 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005764 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005765 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005766 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5767 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005768 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005769 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5770 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005771 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005772 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005773 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5774 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5775 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5776 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005777 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5778 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5779 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5780 "levelCount of 1 but it is %u.",
5781 string_VkImageViewType(view_type), string_VkImageType(image_type),
5782 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005783 }
5784 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005785 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5786 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5787 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005788 }
5789 }
5790 } else {
5791 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005792 // Help point to VK_KHR_maintenance1
5793 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5794 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5795 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5796 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5797 string_VkImageViewType(view_type), string_VkImageType(image_type));
5798 } else {
5799 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5800 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5801 string_VkImageViewType(view_type), string_VkImageType(image_type));
5802 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005803 }
5804 }
5805 break;
5806 default:
5807 break;
5808 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005809
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005810 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005811 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005812 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005813 }
5814
Jeremy Gebben9f537102021-10-05 16:37:12 -06005815 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005816
sfricke-samsung828e59d2021-08-22 23:20:49 -07005817 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005818 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5819 if (view_format != VK_FORMAT_R8_UINT) {
5820 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5821 "vkCreateImageView() If image was created with usage containing "
5822 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5823 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005824 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005825 }
5826
sfricke-samsung828e59d2021-08-22 23:20:49 -07005827 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00005828 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5829 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5830 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5831 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5832 "vkCreateImageView() If image was created with usage containing "
5833 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5834 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5835 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005836 }
5837 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005838
Tobias Hector6663c9b2020-11-05 10:18:02 +00005839 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5840 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005841 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005842 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5843 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005844 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005845 }
5846
sfricke-samsung20a8a372021-07-14 06:12:17 -07005847 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5848 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5849 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005850 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5851 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005852 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005853 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005854 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005855 skip |= LogError(
5856 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5857 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005858 remaining_layers);
5859 }
5860 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5861 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5862 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5863 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5864 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5865 string_VkImageViewType(view_type), remaining_layers);
5866 }
5867 } else {
5868 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5869 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5870 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5871 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5872 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5873 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005874 }
5875 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005876
5877 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5878 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005879 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005880 "vkCreateImageView(): If image was created with usage containing "
5881 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5882 pCreateInfo->subresourceRange.levelCount);
5883 }
5884 }
5885 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5886 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005887 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005888 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5889 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5890 }
5891 } else {
5892 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5893 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5894 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005895 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005896 "vkCreateImageView(): If image was created with usage containing "
5897 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5898 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5899 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5900 }
5901 }
5902 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005903
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005904 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5905 if (pCreateInfo->subresourceRange.levelCount != 1) {
5906 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5907 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5908 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5909 pCreateInfo->subresourceRange.levelCount);
5910 }
5911 if (pCreateInfo->subresourceRange.layerCount != 1) {
5912 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5913 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5914 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5915 pCreateInfo->subresourceRange.layerCount);
5916 }
5917 }
5918
Nathaniel Cesario42d5b282021-08-17 12:47:24 -06005919 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(view_format) &&
ziga-lunargc290c7f2021-07-31 22:01:46 +02005920 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5921 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5922 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5923 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5924 string_VkFormat(image_format));
5925 }
5926
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005927 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5928 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5929 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5930 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5931 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5932 }
5933 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5934 skip |=
5935 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5936 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5937 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5938 }
5939 }
sfricke-samsung45996a42021-09-16 13:45:27 -07005940 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005941 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005942 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005943 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5944 "vkCreateImageView(): If image was created with flags containing "
5945 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5946 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005947 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005948 }
5949 }
5950
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005951 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07005952 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005953 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5954 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5955 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5956 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5957 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5958 }
5959 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005960
sfricke-samsung45996a42021-09-16 13:45:27 -07005961 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005962 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005963 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5964 // VK_COMPONENT_SWIZZLE_IDENTITY."
5965 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5966 // also be defined via R, G, B, A enums in the correct order.
5967 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005968 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005969 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005970 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5971 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5972 }
5973
5974 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5975 // disabled
5976 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5977 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5978 // spec. See Github issue #2361.
5979 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5980 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5981 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07005982 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005983 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5984 "vkCreateImageView (portability error): ImageView format must have"
5985 " the same number of components and bits per component as the Image's format");
5986 }
5987 }
Tony-LunarG69604c42021-11-22 16:00:12 -07005988
5989 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
5990 if (image_view_min_lod) {
5991 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
5992 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
5993 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
5994 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
5995 image_view_min_lod->minLod);
5996 }
5997 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
5998 if (image_view_min_lod->minLod > max_level) {
5999 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
6000 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
6001 "accessible to the view (%" PRIu32 ")",
6002 image_view_min_lod->minLod, max_level);
6003 }
6004 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006005 }
6006 return skip;
6007}
6008
Jeff Leger178b1e52020-10-05 12:22:23 -04006009template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006010bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Tony-LunarGef035472021-11-02 10:23:33 -06006011 uint32_t regionCount, const RegionType *pRegions, CMD_TYPE cmd_type) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006012 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006013 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6014 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006015 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006016
6017 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6018 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
6019 VkDeviceSize src_min = UINT64_MAX;
6020 VkDeviceSize src_max = 0;
6021 VkDeviceSize dst_min = UINT64_MAX;
6022 VkDeviceSize dst_max = 0;
6023
6024 for (uint32_t i = 0; i < regionCount; i++) {
6025 src_min = std::min(src_min, pRegions[i].srcOffset);
6026 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
6027 dst_min = std::min(dst_min, pRegions[i].dstOffset);
6028 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
6029
6030 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
6031 if (pRegions[i].srcOffset >= src_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006032 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006033 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006034 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6035 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
6036 func_name, i, pRegions[i].srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006037 }
6038
6039 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
6040 if (pRegions[i].dstOffset >= dst_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006041 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006042 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006043 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6044 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
6045 func_name, i, pRegions[i].dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006046 }
6047
6048 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6049 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006050 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006051 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006052 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006053 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006054 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006055 }
6056
6057 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6058 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006059 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006060 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006061 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006062 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006063 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006064 }
6065 }
6066
6067 // 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 -06006068 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006069 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Tony-LunarGef035472021-11-02 10:23:33 -06006070 vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006071 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04006072 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006073 }
6074 }
6075
6076 return skip;
6077}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006078template <typename RegionType>
6079bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Tony-LunarGef035472021-11-02 10:23:33 -06006080 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006081 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006082 const auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6083 const auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Tony-LunarGef035472021-11-02 10:23:33 -06006084 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006085 const char *func_name = CommandTypeString(cmd_type);
6086 const char *vuid;
6087
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006088 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006089 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006090 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006091 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006092 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006093
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006094 // Validate that SRC & DST buffers have correct usage flags set
Tony-LunarGef035472021-11-02 10:23:33 -06006095 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006096 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006097 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGef035472021-11-02 10:23:33 -06006098 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006099 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006100 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6101
Jeremy Gebben9f537102021-10-05 16:37:12 -06006102 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarGef035472021-11-02 10:23:33 -06006103 skip |= ValidateCmdCopyBufferBounds(src_buffer_state.get(), dst_buffer_state.get(), regionCount, pRegions, cmd_type);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006104
Tony-LunarGef035472021-11-02 10:23:33 -06006105 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006106 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006107 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006108 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006109 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006110 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006111
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006112 return skip;
6113}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006114
sfricke-samsung11813ab2021-10-20 14:53:37 -07006115bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6116 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Tony-LunarGef035472021-11-02 10:23:33 -06006117 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006118}
6119
Jeff Leger178b1e52020-10-05 12:22:23 -04006120bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6121 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006122 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
Tony-LunarGef035472021-11-02 10:23:33 -06006123 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6124}
6125
6126bool CoreChecks::PreCallValidateCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) const {
6127 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6128 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006129}
6130
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006131bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006132 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006133 auto buffer_state = Get<BUFFER_STATE>(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006134 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006135 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006136 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6137 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006138 }
6139 }
6140 return skip;
6141}
6142
Jeff Bolz5c801d12019-10-09 10:38:45 -05006143bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6144 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006145 const auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006146
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006147 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006148 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006149 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006150 }
6151 return skip;
6152}
6153
Jeff Bolz5c801d12019-10-09 10:38:45 -05006154bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006155 return ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006156}
6157
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006158void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6159 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6160 if (buffer_state) {
Jeremy Gebben65975ed2021-10-29 11:16:10 -06006161 buffer_address_map_.erase(buffer_state->deviceAddress);
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006162 }
6163 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6164}
6165
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006166bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006167 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006168 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006169 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006170 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006171 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006172 }
6173 return skip;
6174}
6175
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006176bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006177 VkDeviceSize size, uint32_t data) const {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006178 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006179 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006180 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006181 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6182 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006183 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006184 skip |=
6185 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6186 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006187
Jeremy Gebben9f537102021-10-05 16:37:12 -06006188 skip |=
6189 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6190 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6191 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006192
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006193 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006194 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6195 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6196 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6197 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006198 }
6199
6200 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006201 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6202 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6203 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6204 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006205 }
6206
sfricke-samsung45996a42021-09-16 13:45:27 -07006207 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006208 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006209 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6210 }
6211
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006212 return skip;
6213}
6214
Jeff Leger178b1e52020-10-05 12:22:23 -04006215template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006216bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006217 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006218 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006219 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006220 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6221 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006222
sfricke-samsung125d2b42020-05-28 06:32:43 -07006223 assert(image_state != nullptr);
6224 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006225
6226 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006227 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006228 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6229 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006230 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006231 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6232 "and 1, respectively.",
6233 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006234 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006235 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006236
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006237 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6238 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006239 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006240 "%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 -07006241 "must be 0 and 1, respectively.",
6242 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006243 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006244 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006245
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006246 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6247 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006248 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006249 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006250 "For 3D images these must be 0 and 1, respectively.",
6251 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006252 }
6253 }
6254
6255 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006256 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006257 const uint32_t element_size =
6258 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006259 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006260
sfricke-samsung8feecc12021-01-23 03:28:38 -08006261 if (FormatIsDepthOrStencil(image_format)) {
6262 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006263 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006264 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6265 " must be a multiple 4 if using a depth/stencil format (%s).",
6266 function, i, bufferOffset, string_VkFormat(image_format));
6267 }
6268 } else {
6269 // If not depth/stencil and not multi-plane
6270 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006271 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
sfricke-samsung8feecc12021-01-23 03:28:38 -08006272 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6273 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006274 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006275 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6276 " must be a multiple of this format's texel size (%" PRIu32 ").",
6277 function, i, bufferOffset, element_size);
6278 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006279 }
6280
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006281 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6282 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006283 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006284 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006285 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006286 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006287 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006288 }
6289
6290 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6291 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006292 vuid =
6293 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006294 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006295 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006296 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6297 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006298 }
6299
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006300 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006301 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006302 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006303 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006304 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6305 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006306 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006307 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006308 "zero or <= image subresource width (%d).",
6309 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006310 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006311 }
6312
6313 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006314 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006315 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6316 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006317 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006318 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006319 "zero or <= image subresource height (%d).",
6320 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006321 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006322 }
6323
6324 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006325 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006326 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6327 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006328 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006329 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006330 "zero or <= image subresource depth (%d).",
6331 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006332 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006333 }
6334
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006335 // subresource aspectMask must have exactly 1 bit set
6336 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006337 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006338 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006339 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006340 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006341 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006342 }
6343
6344 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006345 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006346 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006347 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006348 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6349 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006350 }
6351
6352 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006353 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006354 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006355
6356 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006357 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006358 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
6359 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
6360 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006361 }
6362
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006363 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006364 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006365 skip |=
6366 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
6367 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
6368 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006369 }
6370
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006371 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006372 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6373 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6374 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006375 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006376 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006377 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006378 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6379 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006380 }
6381
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006382 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006383 if (SafeModulo(bufferOffset, element_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006384 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006385 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006386 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006387 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006388 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006389
6390 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006391 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006392 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006393 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006394 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006395 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006396 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006397 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6398 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006399 }
6400
6401 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006402 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006403 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006404 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006405 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006406 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006407 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6408 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006409 }
6410
6411 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006412 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006413 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006414 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006415 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006416 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006417 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6418 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006419 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006420 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006421
6422 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006423 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006424 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006425 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006426 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006427 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006428 "format has three planes.",
6429 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006430 }
6431
6432 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006433 if (0 ==
6434 (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 -06006435 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006436 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006437 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6438 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006439 } else {
6440 // Know aspect mask is valid
6441 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6442 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006443 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006444 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006445 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006446 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006447 " 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 -08006448 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006449 string_VkFormat(compatible_format));
6450 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006451 }
6452 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006453
6454 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006455 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006456 assert(command_pool != nullptr);
6457 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006458 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006459 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006460 LogObjectList objlist(cb_node->commandBuffer());
6461 objlist.add(command_pool->commandPool());
6462 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006463 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6464 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6465 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6466 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006467 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6468 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006469 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006470 }
6471
6472 return skip;
6473}
6474
Jeff Leger178b1e52020-10-05 12:22:23 -04006475template <typename BufferImageCopyRegionType>
6476bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6477 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006478 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006479 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006480
6481 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006482 VkExtent3D extent = pRegions[i].imageExtent;
6483 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006484
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006485 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6486 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006487 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006488 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6489 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006490 }
6491
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006492 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006493
sfricke-samsung01da6312021-10-20 07:51:32 -07006494 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6495 // vkspec.html#_common_operation)
6496 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006497 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006498 if (image_extent.width % block_extent.width) {
6499 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6500 }
6501 if (image_extent.height % block_extent.height) {
6502 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6503 }
6504 if (image_extent.depth % block_extent.depth) {
6505 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6506 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006507 }
6508
Dave Houltonfc1a4052017-04-27 14:32:45 -06006509 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006510 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006511 }
6512 }
6513
6514 return skip;
6515}
6516
Jeff Leger178b1e52020-10-05 12:22:23 -04006517template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006518bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006519 const BufferImageCopyRegionType *pRegions, const char *func_name,
6520 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006521 bool skip = false;
6522
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006523 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006524
6525 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006526 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format);
6527 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6528 if (buffer_copy_size != 0) {
6529 const VkDeviceSize max_buffer_copy = buffer_copy_size + pRegions[i].bufferOffset;
6530 if (buffer_size < max_buffer_copy) {
6531 skip |= LogError(device, msg_code,
6532 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6533 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
6534 func_name, i, buffer_copy_size, pRegions[i].bufferOffset,
6535 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6536 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006537 }
6538 }
6539
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006540 return skip;
6541}
6542
Jeff Leger178b1e52020-10-05 12:22:23 -04006543template <typename BufferImageCopyRegionType>
6544bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6545 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6546 CopyCommandVersion version) const {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006547 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006548 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
6549 const auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006550
Jeff Leger178b1e52020-10-05 12:22:23 -04006551 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006552 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
sfricke-samsung85584a72021-09-30 21:43:38 -07006553 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006554 const char *vuid;
6555
Jeremy Gebben9f537102021-10-05 16:37:12 -06006556 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006557
6558 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006559 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006560
6561 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006562 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006563
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006564 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006565
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006566 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006567 vuid =
6568 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6569 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6570 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6571 "or transfer capabilities.",
6572 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006573 }
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006574 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006575 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006576 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006577 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006578
Jeff Leger178b1e52020-10-05 12:22:23 -04006579 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6580 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006581 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006582
6583 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006584 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006585 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006586 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006587
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006588 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006589 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006590 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006591 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006592 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006593 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006594 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006595 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006596 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006597 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006598 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006599 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006600 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006601
6602 // Validation for VK_EXT_fragment_density_map
6603 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006604 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006605 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006606 "%s: srcImage must not have been created with flags containing "
6607 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6608 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006609 }
6610
sfricke-samsung45996a42021-09-16 13:45:27 -07006611 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006612 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
Lionel Landwerlin21719f62021-12-09 11:40:09 +02006613 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT_KHR, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006614 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006615 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006616
sfricke-samsung45996a42021-09-16 13:45:27 -07006617 const char *src_invalid_layout_vuid =
6618 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6619 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6620 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6621 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6622 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006623
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006624 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006625 skip |= ValidateImageSubresourceLayers(cb_node.get(), &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04006626 vuid =
6627 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006628 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006629 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6630 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006631 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &pRegions[i], i,
6632 func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006633 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6634 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006635 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), pRegions[i].imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006636 "imageSubresource", vuid);
6637 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6638 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006639 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006640 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006641 }
6642 return skip;
6643}
6644
Jeff Leger178b1e52020-10-05 12:22:23 -04006645bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6646 VkBuffer dstBuffer, uint32_t regionCount,
6647 const VkBufferImageCopy *pRegions) const {
6648 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6649 COPY_COMMAND_VERSION_1);
6650}
6651
6652bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6653 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6654 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6655 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6656 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6657}
6658
John Zulauf1686f232019-07-09 16:27:11 -06006659void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6660 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6661 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6662
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006663 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006664 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006665 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006666 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006667 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006668 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006669}
6670
Jeff Leger178b1e52020-10-05 12:22:23 -04006671void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6672 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6673 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6674
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006675 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006676 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006677 // Make sure that all image slices record referenced layout
6678 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006679 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6680 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006681 }
6682}
6683
6684template <typename RegionType>
6685bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6686 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6687 CopyCommandVersion version) const {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006688 const auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006689 const auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6690 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006691
Jeff Leger178b1e52020-10-05 12:22:23 -04006692 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006693 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07006694 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006695 const char *vuid;
6696
Jeremy Gebben9f537102021-10-05 16:37:12 -06006697 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006698
6699 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006700 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006701
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006702 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006703 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006704 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006705 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006706
6707 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6708 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006709 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006710 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006711 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006712 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006713 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006714 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006715 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006716 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006717 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006718 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006719 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006720 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006721 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006722 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006723 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006724 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006725 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006726
6727 // Validation for VK_EXT_fragment_density_map
6728 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006729 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006730 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006731 "%s: dstImage must not have been created with flags containing "
6732 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6733 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006734 }
6735
sfricke-samsung45996a42021-09-16 13:45:27 -07006736 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006737 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
Lionel Landwerlin21719f62021-12-09 11:40:09 +02006738 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006739 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006740 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006741
sfricke-samsung45996a42021-09-16 13:45:27 -07006742 const char *dst_invalid_layout_vuid =
6743 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6744 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6745 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6746 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6747 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006748
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006749 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006750 skip |= ValidateImageSubresourceLayers(cb_node.get(), &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04006751 vuid =
6752 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006753 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006754 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6755 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006756 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &pRegions[i], i,
6757 func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006758 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6759 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006760 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), pRegions[i].imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006761 "imageSubresource", vuid);
6762 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6763 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006764 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006765 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006766
6767 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006768 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07006769 assert(command_pool != nullptr);
6770 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006771 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsungea4fd142020-10-17 23:51:59 -07006772 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6773 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6774 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006775 LogObjectList objlist(cb_node->commandBuffer());
6776 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006777 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6778 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006779 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006780 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6781 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6782 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006783 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6784 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006785 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006786 }
6787 return skip;
6788}
6789
Jeff Leger178b1e52020-10-05 12:22:23 -04006790bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6791 VkImageLayout dstImageLayout, uint32_t regionCount,
6792 const VkBufferImageCopy *pRegions) const {
6793 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6794 COPY_COMMAND_VERSION_1);
6795}
6796
6797bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6798 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6799 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6800 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6801 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6802}
6803
John Zulauf1686f232019-07-09 16:27:11 -06006804void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6805 VkImageLayout dstImageLayout, uint32_t regionCount,
6806 const VkBufferImageCopy *pRegions) {
6807 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6808
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006809 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006810 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006811 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006812 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006813 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006814 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006815}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006816
Jeff Leger178b1e52020-10-05 12:22:23 -04006817void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6818 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6819 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6820
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006821 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006822 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006823 // Make sure that all image slices are record referenced layout
6824 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006825 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6826 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006827 }
6828}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006829bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006830 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006831 bool skip = false;
6832 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6833
Dave Houlton1d960ff2018-01-19 12:17:05 -07006834 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006835 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6836 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6837 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006838 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6839 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006840 }
6841
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006842 const auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006843 if (!image_entry) {
6844 return skip;
6845 }
6846
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006847 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07006848 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006849 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6850 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006851 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6852 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6853 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006854 }
6855 } else {
6856 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006857 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6858 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006859 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006860 }
6861
Dave Houlton1d960ff2018-01-19 12:17:05 -07006862 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006863 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006864 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6865 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6866 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006867 }
6868
Dave Houlton1d960ff2018-01-19 12:17:05 -07006869 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006870 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006871 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6872 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6873 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006874 }
6875
Dave Houlton1d960ff2018-01-19 12:17:05 -07006876 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006877 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006878 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6879 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006880 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006881 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6882 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006883 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006884 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6885 }
6886 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006887 skip |= LogError(image, vuid,
6888 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6889 ") must be a single-plane specifier flag.",
6890 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006891 }
6892 } else if (FormatIsColor(img_format)) {
6893 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02006894 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006895 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6896 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006897 }
6898 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006899 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006900 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006901 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02006902 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
6903 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
6904 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6905 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
6906 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
6907 string_VkFormat(img_format));
6908 }
6909 } else {
6910 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
6911 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
6912 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
6913 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
6914 string_VkFormat(img_format));
6915 }
6916 }
6917 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
6918 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
6919 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6920 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
6921 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
6922 string_VkFormat(img_format));
6923 }
6924 } else {
6925 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
6926 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
6927 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
6928 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
6929 string_VkFormat(img_format));
6930 }
6931 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006932 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6933 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6934 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6935 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006936 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6937 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6938 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006939 }
6940 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006941
sfricke-samsung45996a42021-09-16 13:45:27 -07006942 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006943 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006944 }
6945
Mike Weiblen672b58b2017-02-21 14:32:53 -07006946 return skip;
6947}
sfricke-samsung022fa252020-07-24 03:26:16 -07006948
6949// Validates the image is allowed to be protected
6950bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006951 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006952 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006953
6954 // if driver supports protectedNoFault the operation is valid, just has undefined values
6955 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006956 LogObjectList objlist(cb_state->commandBuffer());
6957 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006958 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 -06006959 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6960 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006961 }
6962 return skip;
6963}
6964
6965// Validates the image is allowed to be unprotected
6966bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006967 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006968 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006969
6970 // if driver supports protectedNoFault the operation is valid, just has undefined values
6971 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006972 LogObjectList objlist(cb_state->commandBuffer());
6973 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006974 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 -06006975 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6976 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006977 }
6978 return skip;
6979}
6980
6981// Validates the buffer is allowed to be protected
6982bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006983 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006984 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006985
6986 // if driver supports protectedNoFault the operation is valid, just has undefined values
6987 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006988 LogObjectList objlist(cb_state->commandBuffer());
6989 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006990 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 -06006991 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6992 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006993 }
6994 return skip;
6995}
6996
6997// Validates the buffer is allowed to be unprotected
6998bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006999 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007000 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007001
7002 // if driver supports protectedNoFault the operation is valid, just has undefined values
7003 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007004 LogObjectList objlist(cb_state->commandBuffer());
7005 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007006 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 -06007007 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7008 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007009 }
7010 return skip;
7011}