blob: 031c35c9d7fe08ed0a13e6f7ec218be5c80f1faf [file] [log] [blame]
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001/* Copyright (c) 2015-2021 The Khronos Group Inc.
2 * Copyright (c) 2015-2021 Valve Corporation
3 * Copyright (c) 2015-2021 LunarG, Inc.
4 * Copyright (C) 2015-2021 Google Inc.
Tony-LunarG5a066372021-01-21 10:31:34 -07005 * Modifications Copyright (C) 2020-2021 Advanced Micro Devices, Inc. All rights reserved.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07006 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060020 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070021 * Shannon McPherson <shannon@lunarg.com>
Tobias Hector6663c9b2020-11-05 10:18:02 +000022 * Author: Tobias Hector <tobias.hector@amd.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070023 */
24
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Jeremy Gebben579aaca2021-02-15 13:36:18 -070029#include <iostream>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070040#include "core_error_location.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070041#include "shader_validation.h"
42#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070043#include "buffer_validation.h"
Jeremy Gebben7ba56152021-06-18 10:40:10 -060044#include "sync_utils.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070045#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070046
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070047// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070048static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070049 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070050 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
51 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
53 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
54 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
55 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
56 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070057 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070058 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
59 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
60 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
61 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
62 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070063 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070064 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
65 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
66 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
67 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
68 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070069 {"00197", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070070 "VUID-vkCmdCopyBufferToImage-pRegions-06218",
71 "VUID-vkCmdCopyImageToBuffer-pRegions-06221",
72 "VUID-VkCopyBufferToImageInfo2KHR-pRegions-06223",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070073 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
74 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070075 {"00198", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070076 "VUID-vkCmdCopyBufferToImage-pRegions-06219",
77 "VUID-vkCmdCopyImageToBuffer-pRegions-06222",
78 "VUID-VkCopyBufferToImageInfo2KHR-pRegions-06224",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070079 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
80 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070081 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070082 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
83 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
84 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
85 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
86 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070087 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070088 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
89 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
90 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
91 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
92 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070093 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070094 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
95 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
96 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
97 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
98 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070099 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700100 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
101 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
102 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
103 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
104 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700105 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700106 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
107 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
108 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
109 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
110 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700111 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700112 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
113 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
114 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
115 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
116 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700117 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700118 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
119 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
120 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
121 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
122 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700123 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700124 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
125 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
126 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
127 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
128 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700129 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700130 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
131 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
132 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
133 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
134 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700135 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700136 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
137 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
138 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
139 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
140 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700141 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700142 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
143 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
144 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
145 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
146 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700147 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700148 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
149 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
150 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
151 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
152 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700153 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700154 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
155 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
156 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
157 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800158 }},
159 {"04052", {
160 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
161 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
162 "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04052",
163 "VUID-VkCopyImageToBufferInfo2KHR-commandBuffer-04052",
164 }},
165 {"04053", {
166 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
167 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
168 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-04053",
169 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700170 }}
171 };
172 // clang-format on
173
174 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700175 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
176 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700177 return copy_imagebuffer_vuid.at(id).at(index);
178}
179
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700180static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200181 switch (layout) {
182 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
183 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
184 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
185
186 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
187 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
188 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
189
190 default:
191 return layout;
192 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700193}
194
195static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200196 switch (layout) {
197 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
198 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
199 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
200
201 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
202 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
203 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
204
205 default:
206 return layout;
207 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700208}
209
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700210static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
211 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
212 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
213 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
214 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
215 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
216 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
217 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
218 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
219 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
220 }
221 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
222 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
223 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
224 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
225 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
226 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
227 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
228 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
229 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
230 }
231 }
232 return layout;
233}
234
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700235static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
236 bool matches = (a == b);
237 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700238 a = NormalizeSynchronization2Layout(aspect_mask, a);
239 b = NormalizeSynchronization2Layout(aspect_mask, b);
240 matches = (a == b);
241 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200242 // Relaxed rules when referencing *only* the depth or stencil aspects.
243 // When accessing both, normalize layouts for aspects separately.
244 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
245 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
246 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
247 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700248 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
249 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
250 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
251 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700252 }
253 }
254 return matches;
255}
256
257// Utility type for ForRange callbacks
258struct LayoutUseCheckAndMessage {
259 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
260 const ImageSubresourceLayoutMap *layout_map;
261 const VkImageAspectFlags aspect_mask;
262 const char *message;
263 VkImageLayout layout;
264
265 LayoutUseCheckAndMessage() = delete;
266 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
267 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
268 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
269 message = nullptr;
270 layout = kInvalidLayout; // Success status
271 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
272 message = "previous known";
273 layout = current_layout;
274 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
275 // To check the relaxed rule matching we need to see how the initial use was used
276 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
277 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
278 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
279 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
280 message = "previously used";
281 layout = initial_layout;
282 }
283 }
284 return layout == kInvalidLayout;
285 }
286};
287
locke-lunarg540b2252020-08-03 13:23:36 -0600288bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600289 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600290 return true;
291 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600292 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600293 return false;
294 }
locke-lunarg540b2252020-08-03 13:23:36 -0600295 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
296 return false;
297 }
298
299 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600300 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600301 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600302 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600303 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600304 }
305
306 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600307 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600308 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600309 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600310 }
311
312 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600313 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600314 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600315 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600316 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600317 }
318
319 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600320 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600321 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600322 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600323 }
locke-lunargdc287022020-08-21 12:03:57 -0600324 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600325}
326
Dave Houltond9611312018-11-19 17:03:36 -0700327uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
328 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700329 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700330}
331
332uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
333
334uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
335
John Zulauf2d60a452021-03-04 15:12:03 -0700336bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben6335df62021-11-01 10:50:13 -0600337 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state);
John Zulauf2076e812020-01-08 14:55:54 -0700338 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700339 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
340 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
341
John Zulauf2076e812020-01-08 14:55:54 -0700342 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
343
344 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700345 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700346 return false;
347 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700348
John Zulauf79f06582021-02-27 18:38:39 -0700349 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700350 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700351 }
352 return true;
353}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700354
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700355bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600356 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700357 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600358 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100359 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600360 const auto &image_view = image_view_state.Handle();
361 const auto *image_state = image_view_state.image_state.get();
362 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100363 const char *vuid;
364 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700365 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100366
367 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600368 LogObjectList objlist(image);
369 objlist.add(renderpass);
370 objlist.add(framebuffer);
371 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700372 skip |=
373 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
374 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
375 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
376 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 return skip;
378 }
379
380 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700381 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200382 if (stencil_usage_info) {
383 image_usage |= stencil_usage_info->stencilUsage;
384 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100385
386 // Check for layouts that mismatch image usages in the framebuffer
387 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800388 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600389 LogObjectList objlist(image);
390 objlist.add(renderpass);
391 objlist.add(framebuffer);
392 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700393 skip |= LogError(objlist, vuid,
394 "%s: Layout/usage mismatch for attachment %u in %s"
395 " - the %s is %s but the image attached to %s via %s"
396 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
397 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
398 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
399 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100400 }
401
402 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
403 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800404 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600405 LogObjectList objlist(image);
406 objlist.add(renderpass);
407 objlist.add(framebuffer);
408 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700409 skip |= LogError(objlist, vuid,
410 "%s: Layout/usage mismatch for attachment %u in %s"
411 " - the %s is %s but the image attached to %s via %s"
412 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
413 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
414 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
415 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100416 }
417
418 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800419 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600420 LogObjectList objlist(image);
421 objlist.add(renderpass);
422 objlist.add(framebuffer);
423 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700424 skip |= LogError(objlist, vuid,
425 "%s: Layout/usage mismatch for attachment %u in %s"
426 " - the %s is %s but the image attached to %s via %s"
427 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
428 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
429 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
430 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100431 }
432
433 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800434 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600435 LogObjectList objlist(image);
436 objlist.add(renderpass);
437 objlist.add(framebuffer);
438 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700439 skip |= LogError(objlist, vuid,
440 "%s: Layout/usage mismatch for attachment %u in %s"
441 " - the %s is %s but the image attached to %s via %s"
442 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
443 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
444 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
445 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100446 }
447
sfricke-samsung45996a42021-09-16 13:45:27 -0700448 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100449 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
450 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
451 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
452 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
453 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800454 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600455 LogObjectList objlist(image);
456 objlist.add(renderpass);
457 objlist.add(framebuffer);
458 objlist.add(image_view);
459 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700460 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700461 " - the %s is %s but the image attached to %s via %s"
462 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700463 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700464 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
465 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466 }
467 } else {
468 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
469 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
470 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
471 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600472 LogObjectList objlist(image);
473 objlist.add(renderpass);
474 objlist.add(framebuffer);
475 objlist.add(image_view);
476 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700477 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700478 " - the %s is %s but the image attached to %s via %s"
479 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700480 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700481 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
482 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100483 }
484 }
485 return skip;
486}
487
John Zulauf17a01bb2019-08-09 16:41:19 -0600488bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700489 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600490 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600491 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600492 const auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
493 const auto *render_pass_info = render_pass_state->createInfo.ptr();
494 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700495 auto const &framebuffer_info = framebuffer_state->createInfo;
496 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100497
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600498 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100499
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700500 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600501 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700502 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700503 }
John Zulauf8e308292018-09-21 11:34:37 -0600504
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700505 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800506 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700507 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508 }
509
Tobias Hectorc9057422019-07-23 12:15:52 +0100510 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700511 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
512 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100513 auto image_view = attachments[i];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600514 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100515
Tobias Hectorc9057422019-07-23 12:15:52 +0100516 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600517 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600518 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600519 objlist.add(image_view);
520 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700521 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600522 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700523 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100524 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100525 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100526
527 const VkImage image = view_state->create_info.image;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600528 const auto *image_state = view_state->image_state.get();
Tobias Hectorc9057422019-07-23 12:15:52 +0100529
530 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600531 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600532 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600533 objlist.add(image_view);
534 objlist.add(image);
535 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700536 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600537 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700538 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100539 continue;
540 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700541 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
542 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100543
Piers Daniell7f894f62020-01-09 16:33:48 -0700544 // Default to expecting stencil in the same layout.
545 auto attachment_stencil_initial_layout = attachment_initial_layout;
546
547 // If a separate layout is specified, look for that.
548 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700549 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700550 if (attachment_description_stencil_layout) {
551 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
552 }
553
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200554 const ImageSubresourceLayoutMap *subresource_map = nullptr;
555 bool has_queried_map = false;
556 bool subres_skip = false;
Tobias Hectorc9057422019-07-23 12:15:52 +0100557
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200558 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
559 VkImageAspectFlags test_aspect = 1u << aspect_index;
560 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
561 continue;
562 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700563
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200564 // Allow for differing depth and stencil layouts
565 VkImageLayout check_layout = attachment_initial_layout;
566 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
567 check_layout = attachment_stencil_initial_layout;
568 }
569
570 if (check_layout != VK_IMAGE_LAYOUT_UNDEFINED) { // If no layout information for image yet, will be checked at QueueSubmit time
571 if (!has_queried_map) {
572 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
573 // in common with the non-const version.)
574 // The lookup is expensive, so cache it.
Jeremy Gebben6335df62021-11-01 10:50:13 -0600575 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200576 has_queried_map = true;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200577 }
John Zulauf5e617452019-11-19 14:44:16 -0700578
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200579 if (subresource_map) {
580 auto normalized_range = view_state->normalized_subresource_range;
581 normalized_range.aspectMask = test_aspect;
582 auto pos = subresource_map->Find(normalized_range);
583 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200584
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200585 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
586 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
587 const VkImageSubresource &subres = pos->subresource;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200588
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200589 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
590 subres_skip |= LogError(
591 device, kVUID_Core_DrawState_InvalidRenderpass,
592 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
593 "and the %s layout of the attachment is %s. The layouts must match, or the render "
594 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
595 i, string_VkImageLayout(check_layout), layout_check.message,
596 string_VkImageLayout(layout_check.layout));
597 }
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200598 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100599 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700600 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100601 }
602
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200603 skip |= subres_skip;
604
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600605 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state, framebuffer,
606 render_pass, i, "initial layout");
Tobias Hectorc9057422019-07-23 12:15:52 +0100607
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600608 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer, render_pass, i,
609 "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100610 }
611
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700612 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
613 auto &subpass = render_pass_info->pSubpasses[j];
614 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100615 auto &attachment_ref = subpass.pInputAttachments[k];
616 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
617 auto image_view = attachments[attachment_ref.attachment];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600618 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100619
Tobias Hectorc9057422019-07-23 12:15:52 +0100620 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600621 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700622 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100623 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100624 }
625 }
626 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100627
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700628 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100629 auto &attachment_ref = subpass.pColorAttachments[k];
630 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
631 auto image_view = attachments[attachment_ref.attachment];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600632 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100633
Tobias Hectorc9057422019-07-23 12:15:52 +0100634 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600635 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Tobias Hectorc9057422019-07-23 12:15:52 +0100636 framebuffer, render_pass, attachment_ref.attachment,
637 "color attachment layout");
638 if (subpass.pResolveAttachments) {
639 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600640 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
641 "resolve attachment layout");
Tobias Hectorc9057422019-07-23 12:15:52 +0100642 }
643 }
644 }
645 }
646
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700647 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100648 auto &attachment_ref = *subpass.pDepthStencilAttachment;
649 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
650 auto image_view = attachments[attachment_ref.attachment];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600651 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorc9057422019-07-23 12:15:52 +0100652
653 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600654 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Tobias Hectorc9057422019-07-23 12:15:52 +0100655 framebuffer, render_pass, attachment_ref.attachment,
656 "input attachment layout");
657 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100658 }
659 }
660 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700661 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600662 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700663}
664
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600665void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700666 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700667 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600668 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600669 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700670 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700671 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700672 if (attachment_reference_stencil_layout) {
673 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
674 }
675
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600676 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600677 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700678 }
679}
680
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600681void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
682 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700683 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700684
685 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700686 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700687 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700688 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700689 }
690 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700691 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700692 }
693 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700694 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700695 }
696 }
697}
698
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700699// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
700// 1. Transition into initialLayout state
701// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600702void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700703 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700704 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700705 auto const rpci = render_pass_state->createInfo.ptr();
706 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600707 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600708 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700709 IMAGE_STATE *image_state = view_state->image_state.get();
710 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700711 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700712 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700713 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700714 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
715 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
716 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600717 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700718 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600719 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700720 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600721 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700722 }
John Zulauf8e308292018-09-21 11:34:37 -0600723 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700724 }
725 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700726 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700727}
728
Dave Houlton10b39482017-03-16 13:18:15 -0600729bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600730 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600731 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600732 }
733 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600734 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600735 }
736 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600737 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600738 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800739 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 -0700740 if (FormatPlaneCount(format) == 1) return false;
741 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600742 return true;
743}
744
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700745// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
746// but some features/extensions can explicitly turn that restriction off
747// The implicit check is done in format utils, while feature checks are done here in CoreChecks
748bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
749 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
750 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
751 return false;
752 }
753 return FormatRequiresYcbcrConversion(format);
754}
755
Mike Weiblen62d08a32017-03-07 22:18:27 -0700756// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700757bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700758 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700759 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700760 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761 switch (layout) {
762 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700763 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700764 break;
765 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700766 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700767 break;
768 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700769 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700770 break;
771 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700772 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700773 break;
774 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700775 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700776 break;
777 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700778 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700779 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600780 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700781 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500782 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700783 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700784 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700785 break;
786 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700787 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700788 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700789 default:
790 // Other VkImageLayout values do not have VUs defined in this context.
791 break;
792 }
793
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700794 if (is_error) {
795 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
796
797 skip |=
798 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
799 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700800 }
801 return skip;
802}
803
804// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700805template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700806bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700807 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700808 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700809 using sync_vuid_maps::GetImageBarrierVUID;
810 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200811
John Zulauf463c51e2018-05-31 13:29:20 -0600812 // Scoreboard for duplicate layout transition barriers within the list
813 // 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 +0200814 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
815 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600816
Mike Weiblen62d08a32017-03-07 22:18:27 -0700817 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700818 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200819 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700820
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600821 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600822 if (image_state) {
823 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700824 skip |=
825 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
826 skip |=
827 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600828
829 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
830 if (image_state->layout_locked) {
831 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700832 skip |= LogError(
833 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700834 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600835 " 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 -0700836 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
837 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600838 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600839
John Zulaufa4472282019-08-22 14:44:34 -0600840 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700841 const VkFormat image_format = image_create_info.format;
842 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600843 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700844 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700845 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700846 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600847 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700848 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
849 skip |= LogError(img_barrier.image, vuid,
850 "%s references %s of format %s that must have either the depth or stencil "
851 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
852 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
853 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600854 }
855 } else {
856 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
857 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700858 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700859 ? ImageError::kNotSeparateDepthAndStencilAspect
860 : ImageError::kNotDepthAndStencilAspect;
861 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700862 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700863 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700864 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700865 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700866 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600867 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700868 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700869 }
John Zulauff660ad62019-03-23 07:16:05 -0600870
Petr Krausad0096a2019-08-09 18:35:04 +0200871 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600872 // TODO: Set memory invalid which is in mem_tracker currently
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200873 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -0600874 auto &write_subresource_map = layout_updates[image_state.get()];
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200875 bool new_write = false;
876 if (!write_subresource_map) {
877 write_subresource_map.emplace(*image_state);
878 new_write = true;
879 }
Jeremy Gebben9f537102021-10-05 16:37:12 -0600880 const auto &current_subresource_map = current_map.find(image_state.get());
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200881 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
882 ? (*current_subresource_map).second
883 : write_subresource_map;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200884
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200885 bool subres_skip = false;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200886 // Validate aspects in isolation.
887 // This is required when handling separate depth-stencil layouts.
888 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
889 VkImageAspectFlags test_aspect = 1u << aspect_index;
890 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
891 continue;
892 }
893
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200894 LayoutUseCheckAndMessage layout_check(&read_subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200895 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
896 normalized_isr.aspectMask = test_aspect;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200897 // 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 +0200898 for (auto pos = read_subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip;
899 pos.IncrementInterval()) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200900 const auto &value = *pos;
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200901 auto old_layout = NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200902 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
903 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
904 subres_skip =
905 LogError(cb_state->commandBuffer(), vuid,
906 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
907 "%s layout is %s.",
908 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
909 value.subresource.aspectMask, value.subresource.mipLevel, value.subresource.arrayLayer,
910 string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
911 string_VkImageLayout(layout_check.layout));
912 }
John Zulauff660ad62019-03-23 07:16:05 -0600913 }
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200914 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
John Zulauf5e617452019-11-19 14:44:16 -0700915 }
John Zulauff660ad62019-03-23 07:16:05 -0600916 skip |= subres_skip;
917 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700918
919 // checks color format and (single-plane or non-disjoint)
920 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
921 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700922 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700923 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700924 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
925 : ImageError::kNotColorAspectYcbcr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700926 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -0700927 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700928 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -0700929 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700930 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700931 string_VkFormat(image_format), aspect_mask);
932 }
933 }
934
935 VkImageAspectFlags valid_disjoint_mask =
936 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 -0700937 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700938 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700939 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
940 skip |= LogError(img_barrier.image, vuid,
941 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -0700942 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700943 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700944 string_VkFormat(image_format), aspect_mask);
945 }
946
947 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700948 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
949 skip |= LogError(img_barrier.image, vuid,
950 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -0700951 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700952 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700953 string_VkFormat(image_format), aspect_mask);
954 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700955 }
956 }
957 return skip;
958}
959
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700960template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700961bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700962 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600963 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700964 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700966 if (!IsTransferOp(barrier)) {
967 return skip;
968 }
969 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600970 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700971 const auto found = barrier_sets.release.find(barrier);
972 if (found != barrier_sets.release.cend()) {
973 barrier_record = &(*found);
974 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -0600975 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600976 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700977 const auto found = barrier_sets.acquire.find(barrier);
978 if (found != barrier_sets.acquire.cend()) {
979 barrier_record = &(*found);
980 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -0600981 }
982 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700983 if (barrier_record != nullptr) {
984 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600985 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700986 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
987 " duplicates existing barrier recorded in this command buffer.",
988 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
989 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
990 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600991 return skip;
992}
993
John Zulaufa4472282019-08-22 14:44:34 -0600994VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
995 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
996}
997
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700998VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
999 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1000}
1001
Jeremy Gebben9f537102021-10-05 16:37:12 -06001002std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1003 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001004 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001005}
1006
Jeremy Gebben9f537102021-10-05 16:37:12 -06001007std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1008 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001009 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001010}
1011
John Zulaufa4472282019-08-22 14:44:34 -06001012VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1013 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1014}
1015
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001016VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1017 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1018}
1019
Jeremy Gebben9f537102021-10-05 16:37:12 -06001020const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1021 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001022 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001023}
1024
Jeremy Gebben9f537102021-10-05 16:37:12 -06001025std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1026 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001027 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001028}
John Zulaufa4472282019-08-22 14:44:34 -06001029
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001030template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001031void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001032 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001033 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001034 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001035 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001036 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001037 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001038 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001039 }
John Zulaufa4472282019-08-22 14:44:34 -06001040
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001041 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1042 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001043 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1044 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001045 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1046
1047 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001048 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1049 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1050 auto handle_state = BarrierHandleState(*this, barrier);
1051 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1052 if (!mode_concurrent) {
1053 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001054 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001055 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001056 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1057 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001058 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001059 src_queue_family, dst_queue_family);
1060 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001061 }
1062 }
1063}
1064
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001065// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001066template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001067bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001068 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1069 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001070 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1071 using sync_vuid_maps::GetImageBarrierVUID;
1072 using sync_vuid_maps::ImageError;
1073
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001074 bool skip = false;
1075 const auto *fb_state = framebuffer;
1076 assert(fb_state);
1077 const auto img_bar_image = img_barrier.image;
1078 bool image_match = false;
1079 bool sub_image_found = false; // Do we find a corresponding subpass description
1080 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1081 uint32_t attach_index = 0;
1082 // Verify that a framebuffer image matches barrier image
1083 const auto attachment_count = fb_state->createInfo.attachmentCount;
1084 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001085 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001086 if (view_state && (img_bar_image == view_state->create_info.image)) {
1087 image_match = true;
1088 attach_index = attachment;
1089 break;
1090 }
1091 }
1092 if (image_match) { // Make sure subpass is referring to matching attachment
1093 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1094 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1095 sub_image_found = true;
1096 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001097 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001098 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1099 if (resolve && resolve->pDepthStencilResolveAttachment &&
1100 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1101 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1102 sub_image_found = true;
1103 }
1104 }
1105 if (!sub_image_found) {
1106 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1107 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1108 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1109 sub_image_found = true;
1110 break;
1111 }
1112 if (!sub_image_found && sub_desc.pResolveAttachments &&
1113 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1114 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1115 sub_image_found = true;
1116 break;
1117 }
1118 }
1119 }
1120 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001121 auto img_loc = loc.dot(Field::image);
1122 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1123 skip |=
1124 LogError(rp_handle, vuid,
1125 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1126 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1127 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001128 }
1129 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001130 auto img_loc = loc.dot(Field::image);
1131 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001132 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 -07001133 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001134 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001135 }
1136 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001137 auto layout_loc = loc.dot(Field::oldLayout);
1138 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001139 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001140 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001141 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001142 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001143 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1144 } else {
1145 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1146 LogObjectList objlist(rp_handle);
1147 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001148 auto layout_loc = loc.dot(Field::oldLayout);
1149 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1150 skip |= LogError(objlist, vuid,
1151 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001152 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001153 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001154 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1155 string_VkImageLayout(img_barrier.oldLayout));
1156 }
1157 }
1158 return skip;
1159}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001160// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001161template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001162 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1163 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1164 const VkImageMemoryBarrier &img_barrier,
1165 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001166template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001167 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1168 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1169 const VkImageMemoryBarrier2KHR &img_barrier,
1170 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001171
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001172template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001173void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001174 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001175 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1176 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1177 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1178 const auto active_subpass = cb_state->activeSubpass;
1179 const auto rp_state = cb_state->activeRenderPass;
1180 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001181 // Secondary CB case w/o FB specified delay validation
1182 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001183 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001184 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001185 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001186 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1187 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1188 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001189 render_pass, barrier, primary_cb);
1190 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001191 }
1192}
1193
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001194void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001195 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1196 const VkImageMemoryBarrier *pImageMemBarriers) {
1197 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001198 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001199 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1200 }
1201 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001202 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001203 const auto &img_barrier = pImageMemBarriers[i];
1204 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1205 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1206 }
1207}
1208
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001209void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001210 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001211 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1213 }
1214 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001215 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001216 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1217 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1218 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1219 }
1220}
1221
1222template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001223bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001224 const char *operation, const TransferBarrier &barrier,
1225 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001226 // Record to the scoreboard or report that we have a duplication
1227 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001228 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001229 if (!inserted.second && inserted.first->second != cb_state) {
1230 // 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 -06001231 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001232 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001233 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001234 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001235 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1236 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001237 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001238 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001239 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001240 }
1241 return skip;
1242}
1243
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001244template <typename TransferBarrier>
1245bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1246 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1247 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001248 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001249 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001250 const char *barrier_name = TransferBarrier::BarrierName();
1251 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001252 // No release should have an extant duplicate (WARNING)
1253 for (const auto &release : cb_barriers.release) {
1254 // Check the global pending release barriers
1255 const auto set_it = global_release_barriers.find(release.handle);
1256 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001257 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001258 const auto found = set_for_handle.find(release);
1259 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001260 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001261 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1262 " to dstQueueFamilyIndex %" PRIu32
1263 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1264 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1265 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001266 }
1267 }
1268 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1269 }
1270 // Each acquire must have a matching release (ERROR)
1271 for (const auto &acquire : cb_barriers.acquire) {
1272 const auto set_it = global_release_barriers.find(acquire.handle);
1273 bool matching_release_found = false;
1274 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001275 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001276 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1277 }
1278 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001279 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001280 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1281 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1282 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1283 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001284 }
1285 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1286 }
1287 return skip;
1288}
1289
John Zulauf3b04ebd2019-07-18 14:08:11 -06001290bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001291 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1292 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001293 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001294 skip |=
1295 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1296 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1297 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001298 return skip;
1299}
1300
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001301template <typename TransferBarrier>
1302void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1303 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001304 // Add release barriers from this submit to the global map
1305 for (const auto &release : cb_barriers.release) {
1306 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1307 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1308 global_release_barriers[release.handle].insert(release);
1309 }
1310
1311 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1312 for (const auto &acquire : cb_barriers.acquire) {
1313 // NOTE: We're not using [] because we don't want to create entries for missing releases
1314 auto set_it = global_release_barriers.find(acquire.handle);
1315 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001316 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001317 set_for_handle.erase(acquire);
1318 if (set_for_handle.size() == 0) { // Clean up empty sets
1319 global_release_barriers.erase(set_it);
1320 }
1321 }
1322 }
1323}
1324
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001325void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001326 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1327 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1328 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001329}
1330
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001331template <typename ImgBarrier>
1332void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1333 // For ownership transfers, the barrier is specified twice; as a release
1334 // operation on the yielding queue family, and as an acquire operation
1335 // on the acquiring queue family. This barrier may also include a layout
1336 // transition, which occurs 'between' the two operations. For validation
1337 // purposes it doesn't seem important which side performs the layout
1338 // transition, but it must not be performed twice. We'll arbitrarily
1339 // choose to perform it as part of the acquire operation.
1340 //
1341 // However, we still need to record initial layout for the "initial layout" validation
1342 for (uint32_t i = 0; i < barrier_count; i++) {
1343 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001344 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001345 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001346 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001347 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001348 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001349 }
1350}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001351// explictly instantiate this template so it can be used in core_validation.cpp
1352template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1353 const VkImageMemoryBarrier *barrier);
1354template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1355 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001356
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001357VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1358
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001359template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001360void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001361 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001362 if (enabled_features.synchronization2_features.synchronization2) {
1363 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1364 return;
1365 }
1366 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001367 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001368
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001369 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1370 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001371
1372 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001373 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001374 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1375 }
1376
John Zulauf2be3fe02019-12-30 09:48:02 -07001377 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001378 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001379 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001380 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001381 }
unknown86bcb3a2019-07-11 13:05:36 -06001382}
1383
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001384bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1385 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1386 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1387 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001388 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001389 assert(cb_node);
1390 assert(image_state);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001391 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001392
Jeremy Gebben6335df62021-11-01 10:50:13 -06001393 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06001394 if (subresource_map) {
1395 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001396 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001397 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1398 // the next "constant value" range
1399 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001400 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001401 *error = true;
Jeremy Gebben6335df62021-11-01 10:50:13 -06001402 subres_skip |=
1403 LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
1404 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1405 "%s layout %s.",
1406 caller, report_data->FormatHandle(image_state->Handle()).c_str(), pos->subresource.arrayLayer,
1407 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1408 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001409 }
John Zulauf5e617452019-11-19 14:44:16 -07001410 }
John Zulauff660ad62019-03-23 07:16:05 -06001411 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001412 }
John Zulauff660ad62019-03-23 07:16:05 -06001413
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001414 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1415 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1416 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001417 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1418 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001419 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001420 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001421 report_data->FormatHandle(image_state->Handle()).c_str(),
1422 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001423 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001424 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001425 if (image_state->shared_presentable) {
1426 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001427 skip |=
1428 LogError(device, layout_invalid_msg_code,
1429 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1430 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001431 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001432 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001433 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001434 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001435 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001436 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001437 report_data->FormatHandle(image_state->Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001438 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001439 }
1440 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001441 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001442}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001443bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001444 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1445 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001446 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001447 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1448 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1449}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001450
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001451void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001452 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001453 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001454 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001455
Mike Schuchardt2df08912020-12-15 16:28:09 -08001456 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001457 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001458 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001459 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001460 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001461 VkImageLayout stencil_layout = kInvalidLayout;
1462 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001463 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001464 if (attachment_description_stencil_layout) {
1465 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1466 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001467 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001468 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001469 }
1470 }
1471}
Dave Houltone19e20d2018-02-02 16:32:41 -07001472
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001473#ifdef VK_USE_PLATFORM_ANDROID_KHR
1474// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1475// This could also move into a seperate core_validation_android.cpp file... ?
1476
1477//
1478// AHB-specific validation within non-AHB APIs
1479//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001480bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001481 bool skip = false;
1482
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001483 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001484 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001485 if (0 != ext_fmt_android->externalFormat) {
1486 if (VK_FORMAT_UNDEFINED != create_info->format) {
1487 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001488 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1489 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1490 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001491 }
1492
1493 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001494 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1495 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1496 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001497 }
1498
1499 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001500 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1501 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001502 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001503 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001504 }
1505
1506 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001507 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1508 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1509 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001510 }
1511 }
1512
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001513 if ((0 != ext_fmt_android->externalFormat) &&
1514 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001515 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001516 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1517 ") which has "
1518 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1519 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001520 }
1521 }
1522
Dave Houltond9611312018-11-19 17:03:36 -07001523 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001524 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 skip |=
1526 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1527 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1528 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001529 }
1530 }
1531
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001532 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001533 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1534 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001535 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001536 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1537 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1538 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1539 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001540 }
1541
1542 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001543 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1544 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1545 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1546 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1547 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001548 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001549 }
1550
1551 return skip;
1552}
1553
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001554bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001555 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001556 const auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001557
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001558 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001559 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001560 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1561 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001562 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001563 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001564 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001565
Dave Houltond9611312018-11-19 17:03:36 -07001566 // Chain must include a compatible ycbcr conversion
1567 bool conv_found = false;
1568 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001569 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001570 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001571 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001572 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001573 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001574 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001575 }
Dave Houltond9611312018-11-19 17:03:36 -07001576 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001577 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001578 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001579 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1580 "an externalFormat (%" PRIu64
1581 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1582 "with the same external format.",
1583 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001584 }
1585
1586 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001587 if (IsIdentitySwizzle(create_info->components) == false) {
1588 skip |= LogError(
1589 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1590 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1591 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1592 "= %s.",
1593 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1594 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001595 }
1596 }
Dave Houltond9611312018-11-19 17:03:36 -07001597
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001598 return skip;
1599}
1600
John Zulaufa26d3c82019-08-14 16:09:08 -06001601bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001602 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001603
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001604 const auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001605 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001606 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001607 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1608 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1609 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1610 "bound to memory.");
1611 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001612 }
1613 return skip;
1614}
1615
1616#else
1617
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001618bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001619 return false;
1620}
1621
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001622bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001623
John Zulaufa26d3c82019-08-14 16:09:08 -06001624bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001625
1626#endif // VK_USE_PLATFORM_ANDROID_KHR
1627
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001628bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1629 bool skip = false;
1630
1631 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1632 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1633 const VkImageTiling image_tiling = pCreateInfo->tiling;
1634 const VkFormat image_format = pCreateInfo->format;
1635
1636 if (image_format == VK_FORMAT_UNDEFINED) {
1637 // VU 01975 states format can't be undefined unless an android externalFormat
1638#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001639 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001640 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1641 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1642 if (it != ahb_ext_formats_map.end()) {
1643 tiling_features = it->second;
1644 }
1645 }
1646#endif
1647 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1648 uint64_t drm_format_modifier = 0;
1649 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001650 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001651 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001652 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001653
1654 if (drm_explicit != nullptr) {
1655 drm_format_modifier = drm_explicit->drmFormatModifier;
1656 } else {
1657 // VUID 02261 makes sure its only explict or implict in parameter checking
1658 assert(drm_implicit != nullptr);
1659 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1660 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1661 }
1662 }
1663
1664 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1665 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1666 nullptr};
1667 format_properties_2.pNext = (void *)&drm_properties_list;
1668 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001669 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1670 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1671 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1672 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001673
1674 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1675 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1676 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1677 }
1678 }
1679 } else {
1680 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1681 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1682 : format_properties.optimalTilingFeatures;
1683 }
1684
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001685 // Lack of disjoint format feature support while using the flag
1686 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1687 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1688 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1689 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1690 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1691 string_VkFormat(pCreateInfo->format));
1692 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001693
1694 return skip;
1695}
1696
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001697bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001698 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001699 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001700
sfricke-samsung45996a42021-09-16 13:45:27 -07001701 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001702 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001703 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1704 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001705 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1706 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001707 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001708 }
1709
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001710 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1711 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001712 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1713 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1714 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001715 }
Dave Houlton130c0212018-01-29 13:39:56 -07001716 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001717
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001718 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001719 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1720 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1721 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001722 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001723 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1724 "device maxFramebufferWidth (%u).",
1725 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001726 }
1727
1728 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001729 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001730 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1731 "device maxFramebufferHeight (%u).",
1732 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001733 }
1734
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001735 VkImageCreateFlags sparseFlags =
1736 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1737 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1738 skip |= LogError(
1739 device, "VUID-VkImageCreateInfo-None-01925",
1740 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1741 }
1742
sfricke-samsung45996a42021-09-16 13:45:27 -07001743 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map) ||
1744 IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001745 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1746 static_cast<float>(device_limits->maxFramebufferWidth) /
1747 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001748 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1749 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001750 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1751 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1752 "ceiling of device "
1753 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1754 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1755 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001756 }
1757
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001758 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1759 static_cast<float>(device_limits->maxFramebufferHeight) /
1760 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001761 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1762 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001763 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1764 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1765 "ceiling of device "
1766 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1767 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1768 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001769 }
1770 }
1771
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001772 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001773 VkResult result = VK_SUCCESS;
1774 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1775 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1776 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1777 &format_limits);
1778 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001779 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1780 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001781 if (modifier_list) {
1782 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001783 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001784 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001785 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001786 image_format_info.type = pCreateInfo->imageType;
1787 image_format_info.format = pCreateInfo->format;
1788 image_format_info.tiling = pCreateInfo->tiling;
1789 image_format_info.usage = pCreateInfo->usage;
1790 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001791 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001792
1793 result =
1794 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1795 format_limits = image_format_properties.imageFormatProperties;
1796
1797 /* The application gives a list of modifier and the driver
1798 * selects one. If one is wrong, stop there.
1799 */
1800 if (result != VK_SUCCESS) break;
1801 }
1802 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001803 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001804 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001805 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001806 image_format_info.type = pCreateInfo->imageType;
1807 image_format_info.format = pCreateInfo->format;
1808 image_format_info.tiling = pCreateInfo->tiling;
1809 image_format_info.usage = pCreateInfo->usage;
1810 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001811 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001812
1813 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1814 format_limits = image_format_properties.imageFormatProperties;
1815 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001816 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001817
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001818 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1819 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1820 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1821 if (result != VK_SUCCESS) {
1822 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001823#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001824 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001825#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001826 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001827 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001828 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1829 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001830#ifdef VK_USE_PLATFORM_ANDROID_KHR
1831 }
1832#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001833 } else {
1834 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1835 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001836 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1837 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1838 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001839 }
Dave Houlton130c0212018-01-29 13:39:56 -07001840
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001841 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1842 static_cast<uint64_t>(pCreateInfo->extent.height) *
1843 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1844 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001845
sfricke-samsung2e827212021-09-28 07:52:08 -07001846 // Depth/Stencil formats size can't be accurately calculated
1847 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1848 uint64_t total_size =
1849 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001850
sfricke-samsung2e827212021-09-28 07:52:08 -07001851 // Round up to imageGranularity boundary
1852 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1853 uint64_t ig_mask = image_granularity - 1;
1854 total_size = (total_size + ig_mask) & ~ig_mask;
1855
1856 if (total_size > format_limits.maxResourceSize) {
1857 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1858 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1859 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1860 total_size, format_limits.maxResourceSize);
1861 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001862 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001863
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001864 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001865 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1866 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1867 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001868 }
1869
1870 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001871 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1872 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1873 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001874 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001875
1876 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1877 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1878 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1879 pCreateInfo->extent.width, format_limits.maxExtent.width);
1880 }
1881
1882 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1883 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1884 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1885 pCreateInfo->extent.height, format_limits.maxExtent.height);
1886 }
1887
1888 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1889 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1890 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1891 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1892 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001893 }
1894
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001895 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001896 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001897 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001898 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001899 ? "VUID-VkImageCreateInfo-format-06414"
1900 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001901 skip |= LogError(device, error_vuid,
1902 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1903 "YCbCr Conversion format, arrayLayers must be 1",
1904 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001905 }
1906
1907 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001908 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001909 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1910 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001911 }
1912
1913 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001914 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001915 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001916 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1917 string_VkSampleCountFlagBits(pCreateInfo->samples));
1918 }
1919
1920 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001921 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001922 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001923 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1924 string_VkImageType(pCreateInfo->imageType));
1925 }
1926 }
1927
sfricke-samsung45996a42021-09-16 13:45:27 -07001928 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001929 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001930 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001931 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1932 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001933 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001934 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001935 }
1936 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001937 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1938 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1939 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001940 }
1941 }
1942 }
1943
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001944 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001945 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1946 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1947 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001948 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001949 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001950 }
1951
unknown2c877272019-07-11 12:56:50 -06001952 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1953 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1954 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001955 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1956 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1957 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001958 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001959
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001960 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001961 if (swapchain_create_info != nullptr) {
1962 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001963 const auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001964 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1965
1966 // Validate rest of Swapchain Image create check that require swapchain state
1967 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1968 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1969 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1970 skip |= LogError(
1971 device, vuid,
1972 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1973 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1974 }
1975 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1976 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1977 skip |= LogError(device, vuid,
1978 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1979 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1980 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08001981 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001982 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1983 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1984 skip |= LogError(device, vuid,
1985 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1986 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08001987 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001988 }
1989 }
1990 }
1991
sfricke-samsungedce77a2020-07-03 22:35:13 -07001992 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1993 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1994 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1995 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1996 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1997 }
1998 const VkImageCreateFlags invalid_flags =
1999 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2000 if ((pCreateInfo->flags & invalid_flags) != 0) {
2001 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2002 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2003 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2004 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2005 }
2006 }
2007
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002008 skip |= ValidateImageFormatFeatures(pCreateInfo);
2009
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002010 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002011 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002012 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2013 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2014 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2015 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2016 }
2017 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2018 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2019 skip |=
2020 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2021 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2022 }
2023 }
2024
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002025 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002026 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2027 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2028 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2029 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2030 "VkExternalMemoryImageCreateInfo chained structs.");
2031 }
2032 if (external_memory_create_info) {
2033 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2034 skip |= LogError(
2035 device, "VUID-VkImageCreateInfo-pNext-01443",
2036 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2037 " but pCreateInfo->initialLayout is %s.",
2038 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2039 }
2040 } else if (external_memory_create_info_nv) {
2041 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2042 skip |= LogError(
2043 device, "VUID-VkImageCreateInfo-pNext-01443",
2044 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2045 " but pCreateInfo->initialLayout is %s.",
2046 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002047 }
2048 }
2049
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002050 if (device_group_create_info.physicalDeviceCount == 1) {
2051 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2052 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2053 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2054 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2055 }
2056 }
2057
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002058 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002059}
2060
John Zulauf7eeb6f72019-06-17 11:56:36 -06002061void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2062 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2063 if (VK_SUCCESS != result) return;
2064
2065 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002066 auto image_state = Get<IMAGE_STATE>(*pImage);
2067 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002068}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002069
Jeff Bolz5c801d12019-10-09 10:38:45 -05002070bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002071 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002072 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002073 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002074 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002075 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002076 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2077 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002078 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002079 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002080 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002081 }
2082 return skip;
2083}
2084
John Zulauf7eeb6f72019-06-17 11:56:36 -06002085void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2086 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002087 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002088 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002089
Jeremy Gebben9f537102021-10-05 16:37:12 -06002090 imageLayoutMap.erase(image_state.get());
John Zulauf7eeb6f72019-06-17 11:56:36 -06002091
2092 // Clean up generic image state
2093 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002094}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002095
sfricke-samsungcd924d92020-05-20 23:51:17 -07002096bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2097 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002098 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002099 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002100 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002101
2102 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002103 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2104 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002105 }
2106
sfricke-samsungcd924d92020-05-20 23:51:17 -07002107 if (FormatIsDepthOrStencil(format)) {
2108 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2109 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2110 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2111 } else if (FormatIsCompressed(format)) {
2112 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2113 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2114 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002115 }
2116
2117 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002118 skip |=
2119 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2120 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2121 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002122 }
2123 return skip;
2124}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002125
John Zulauf07288512019-07-05 11:09:50 -06002126bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2127 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2128 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002129 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002130 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2131 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002132 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002133 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2134 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002135 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002136
2137 } else {
2138 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002139 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002140 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002141 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002142 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2143 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002144 }
2145 } else {
2146 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2147 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002148 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002149 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002150 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2151 func_name, string_VkImageLayout(dest_image_layout));
2152 }
2153 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002154 }
2155
John Zulauff660ad62019-03-23 07:16:05 -06002156 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002157 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002158 if (subresource_map) {
2159 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002160 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002161 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002162 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2163 // the next "constant value" range
2164 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002165 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002166 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2167 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2168 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2169 } else {
2170 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002171 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002172 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002173 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2174 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2175 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002176 }
John Zulauf5e617452019-11-19 14:44:16 -07002177 }
John Zulauff660ad62019-03-23 07:16:05 -06002178 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002179 }
2180
2181 return skip;
2182}
2183
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002184bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2185 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002186 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002187 bool skip = false;
2188 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002189 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2190 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002191 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002192 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2193 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002194 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002195 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002196 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002197 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002198 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2199 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2200 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002201 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002202 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002203 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002204 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2205 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2206 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002207 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002208 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002209 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002210 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2211 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2212 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2213 string_VkFormat(image_state->createInfo.format));
2214 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002215 }
2216 return skip;
2217}
2218
John Zulaufeabb4462019-07-05 14:13:03 -06002219void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2220 const VkClearColorValue *pColor, uint32_t rangeCount,
2221 const VkImageSubresourceRange *pRanges) {
2222 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2223
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002224 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2225 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002226 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002227 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002228 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002229 }
2230 }
2231}
2232
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002233bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2234 const char *apiName) const {
2235 bool skip = false;
2236
2237 // 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 -07002238 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002239 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2240 // Also VUID-VkClearDepthStencilValue-depth-00022
2241 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2242 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2243 "(=%f) is not within the [0.0, 1.0] range.",
2244 apiName, clearValue.depth);
2245 }
2246 }
2247
2248 return skip;
2249}
2250
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002251bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2252 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002253 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002254 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002255
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002256 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002257 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2258 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002259 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002260 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002261 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002262 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002263 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002264 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002265 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
2266 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002267 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002268 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002269 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002270 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002271 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002272 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002273
2274 bool any_include_aspect_depth_bit = false;
2275 bool any_include_aspect_stencil_bit = false;
2276
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002277 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002278 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002279 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2280 skip |=
2281 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002282 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002283 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2284 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002285 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2286 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2287 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2288 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002289 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002290 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2291 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002292 if (FormatHasDepth(image_format) == false) {
2293 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2294 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2295 "doesn't have a depth component.",
2296 i, string_VkFormat(image_format));
2297 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002298 }
2299 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2300 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002301 if (FormatHasStencil(image_format) == false) {
2302 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2303 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2304 "%s doesn't have a stencil component.",
2305 i, string_VkFormat(image_format));
2306 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002307 }
2308 }
2309 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002310 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002311 if (image_stencil_struct != nullptr) {
2312 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2313 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002314 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2315 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2316 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2317 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002318 }
2319 } else {
2320 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002321 skip |= LogError(
2322 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002323 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2324 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2325 "in VkImageCreateInfo::usage used to create image");
2326 }
2327 }
2328 }
2329 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002330 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2331 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2332 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002333 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002334 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002335 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2336 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002337 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002338 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002339 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002340 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2341 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2342 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2343 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002344 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002345 }
2346 return skip;
2347}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002348
John Zulaufeabb4462019-07-05 14:13:03 -06002349void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2350 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2351 const VkImageSubresourceRange *pRanges) {
2352 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002353 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2354 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002355 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002356 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002357 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002358 }
2359 }
2360}
2361
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002362// Returns true if [x, xoffset] and [y, yoffset] overlap
2363static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2364 bool result = false;
2365 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2366 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2367
2368 if (intersection_max > intersection_min) {
2369 result = true;
2370 }
2371 return result;
2372}
2373
Jeff Leger178b1e52020-10-05 12:22:23 -04002374// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002375// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002376template <typename RegionType>
2377static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002378 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002379
Dave Houltonc991cc92018-03-06 11:08:51 -07002380 // Separate planes within a multiplane image cannot intersect
2381 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002382 return result;
2383 }
2384
Dave Houltonc991cc92018-03-06 11:08:51 -07002385 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2386 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2387 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002388 result = true;
2389 switch (type) {
2390 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002391 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002392 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002393 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002394 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002395 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002396 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002397 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002398 break;
2399 default:
2400 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2401 assert(false);
2402 }
2403 }
2404 return result;
2405}
2406
Dave Houltonfc1a4052017-04-27 14:32:45 -06002407// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002408static const uint32_t kXBit = 1;
2409static const uint32_t kYBit = 2;
2410static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002411static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002412 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002413 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002414 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2415 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002416 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002417 }
2418 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2419 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002420 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002421 }
2422 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2423 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002424 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002425 }
2426 return result;
2427}
2428
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002429// Test if two VkExtent3D structs are equivalent
2430static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2431 bool result = true;
2432 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2433 (extent->depth != other_extent->depth)) {
2434 result = false;
2435 }
2436 return result;
2437}
2438
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002439// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002440static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002441 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2442}
2443
2444// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002445VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002446 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2447 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002448 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002449 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002450 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002451 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002452 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002453 granularity.width *= block_size.width;
2454 granularity.height *= block_size.height;
2455 }
2456 }
2457 return granularity;
2458}
2459
2460// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2461static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2462 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002463 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2464 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002465 valid = false;
2466 }
2467 return valid;
2468}
2469
2470// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002471bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002472 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002473 bool skip = false;
2474 VkExtent3D offset_extent = {};
2475 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2476 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2477 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002478 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002479 // 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 -07002480 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002481 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002482 "%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 "
2483 "image transfer granularity is (w=0, h=0, d=0).",
2484 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002485 }
2486 } else {
2487 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2488 // integer multiples of the image transfer granularity.
2489 if (IsExtentAligned(&offset_extent, granularity) == 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) dimensions must be even integer multiples of this command "
2492 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2493 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2494 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002495 }
2496 }
2497 return skip;
2498}
2499
2500// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002501bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002502 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002503 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002504 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002505 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002506 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2507 // subresource extent.
2508 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002509 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002510 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2511 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2512 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2513 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002514 }
2515 } else {
2516 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2517 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2518 // subresource extent dimensions.
2519 VkExtent3D offset_extent_sum = {};
2520 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2521 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2522 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002523 bool x_ok = true;
2524 bool y_ok = true;
2525 bool z_ok = true;
2526 switch (image_type) {
2527 case VK_IMAGE_TYPE_3D:
2528 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2529 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002530 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002531 case VK_IMAGE_TYPE_2D:
2532 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2533 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002534 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002535 case VK_IMAGE_TYPE_1D:
2536 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2537 (subresource_extent->width == offset_extent_sum.width));
2538 break;
2539 default:
2540 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2541 assert(false);
2542 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002543 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002544 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002545 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002546 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2547 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2548 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2549 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2550 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2551 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002552 }
2553 }
2554 return skip;
2555}
2556
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002557bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002558 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002559 bool skip = false;
2560 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002561 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2562 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002563 }
2564 return skip;
2565}
2566
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002567bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002568 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002569 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002570 bool skip = false;
2571 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2572 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002573 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002574 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2575 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002576 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002577 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002578 }
2579 return skip;
2580}
2581
Jeff Leger178b1e52020-10-05 12:22:23 -04002582// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2583template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002584bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002585 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002586 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002588 VkExtent3D granularity = GetScaledItg(cb_node, img);
2589 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002590 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002591 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002592 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002593 return skip;
2594}
2595
Jeff Leger178b1e52020-10-05 12:22:23 -04002596// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2597template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002598bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002599 const IMAGE_STATE *dst_img, const RegionType *region,
2600 const uint32_t i, const char *function,
2601 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002602 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002603 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2604 const char *vuid;
2605
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002606 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002607 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002608 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2609 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002610 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002611 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002612 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002613 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002614 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002615
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002616 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002617 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002618 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2619 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002620 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002621 const VkExtent3D dest_effective_extent =
2622 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002623 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002624 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002625 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002626 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002627 return skip;
2628}
2629
Jeff Leger178b1e52020-10-05 12:22:23 -04002630// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2631template <typename ImageCopyRegionType>
2632bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2633 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2634 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002635 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002636 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2637 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2638 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002639
2640 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002641 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002642
2643 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002644 const VkExtent3D src_copy_extent = region.extent;
2645 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002646 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2647
Dave Houlton6f9059e2017-05-02 17:15:13 -06002648 bool slice_override = false;
2649 uint32_t depth_slices = 0;
2650
2651 // Special case for copying between a 1D/2D array and a 3D image
2652 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2653 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002654 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002655 slice_override = (depth_slices != 1);
2656 } 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 -07002657 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002658 slice_override = (depth_slices != 1);
2659 }
2660
2661 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002662 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002663 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002664 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002665 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002666 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2667 "be 0 and 1, respectively.",
2668 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002669 }
2670 }
2671
Dave Houlton533be9f2018-03-26 17:08:30 -06002672 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002673 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
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.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002676 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002677 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002678 }
2679
Dave Houlton533be9f2018-03-26 17:08:30 -06002680 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002681 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002682 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 -04002683 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002684 }
2685
sfricke-samsung01da6312021-10-20 07:51:32 -07002686 // Source checks that apply only to "blocked images"
2687 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002688 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002689 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002690 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2691 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2692 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002693 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002694 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002695 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002696 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002697 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002698 }
2699
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002700 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002701 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2702 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002703 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002704 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002705 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002706 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2707 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002708 }
2709
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002710 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002711 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2712 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002713 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002714 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002715 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2716 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2717 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002718 }
2719
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002720 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002721 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2722 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002723 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002724 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002725 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2726 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2727 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002728 }
2729 } // Compressed
2730
2731 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002732 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002733 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002735 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002736 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002737 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002738 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002739 }
2740 }
2741
Dave Houlton533be9f2018-03-26 17:08:30 -06002742 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002743 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
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.z is %d and extent.depth is %d. For 1D images these must be 0 "
2746 "and 1, respectively.",
2747 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002748 }
2749
Dave Houlton533be9f2018-03-26 17:08:30 -06002750 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002751 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002752 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 -04002753 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002754 }
2755
sfricke-samsung30b094c2020-05-30 11:42:11 -07002756 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002757 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002758 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2759 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002760 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002761 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2763 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2764 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002765 }
2766 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002767 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002768 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002769 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002770 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2772 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2773 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002774 }
2775 }
2776 } else { // Pre maint 1
2777 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002778 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002779 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002780 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002781 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002782 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2783 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002784 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002785 }
Dave Houltonee281a52017-12-08 13:51:02 -07002786 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002787 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002788 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002789 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002790 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2791 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002792 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002793 }
2794 }
2795 }
2796
sfricke-samsung01da6312021-10-20 07:51:32 -07002797 // Dest checks that apply only to "blocked images"
2798 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002799 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002800
2801 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002802 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2803 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2804 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002805 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002806 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002807 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002808 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002809 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002810 }
2811
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002812 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002813 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2814 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002815 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002816 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002817 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002818 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2819 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002820 }
2821
Dave Houltonee281a52017-12-08 13:51:02 -07002822 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2823 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2824 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002825 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002826 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002827 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002828 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2829 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002830 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002831 }
2832
Dave Houltonee281a52017-12-08 13:51:02 -07002833 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2834 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2835 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002836 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002837 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002838 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2839 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2840 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002841 }
2842 } // Compressed
2843 }
2844 return skip;
2845}
2846
Jeff Leger178b1e52020-10-05 12:22:23 -04002847template <typename RegionType>
2848bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2849 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2850 const RegionType *pRegions, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002851 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2852 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
2853 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002854 const VkFormat src_format = src_image_state->createInfo.format;
2855 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002856 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002857 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002858
Jeff Leger178b1e52020-10-05 12:22:23 -04002859 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07002860 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002861 const char *vuid;
2862
Jeremy Gebben9f537102021-10-05 16:37:12 -06002863 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002864
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002865 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002866
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002867 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002868 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002869
2870 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2871 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002872 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002873
Dave Houlton6f9059e2017-05-02 17:15:13 -06002874 bool slice_override = false;
2875 uint32_t depth_slices = 0;
2876
2877 // Special case for copying between a 1D/2D array and a 3D image
2878 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2879 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2880 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002881 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002882 slice_override = (depth_slices != 1);
2883 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2884 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002885 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002886 slice_override = (depth_slices != 1);
2887 }
2888
Jeremy Gebben9f537102021-10-05 16:37:12 -06002889 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
2890 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04002891 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002892 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name,
2893 "srcSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04002894 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002895 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name,
2896 "dstSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04002897 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002898 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002899 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2900 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002901 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002902 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002903
sfricke-samsung45996a42021-09-16 13:45:27 -07002904 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002905 // No chance of mismatch if we're overriding depth slice count
2906 if (!slice_override) {
2907 // The number of depth slices in srcSubresource and dstSubresource must match
2908 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2909 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002910 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2911 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002912 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002913 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2914 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002915 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002916 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2917 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002918 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2919 "do not match.",
2920 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002921 }
2922 }
2923 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002924 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002925 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002926 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002927 skip |=
2928 LogError(command_buffer, vuid,
2929 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2930 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002931 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002932 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002933
Dave Houltonc991cc92018-03-06 11:08:51 -07002934 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002935 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002936 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2937 // If neither image is multi-plane the aspectMask member of src and dst must match
2938 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2939 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2940 skip |= LogError(command_buffer, vuid,
2941 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2942 "source (0x%x) destination (0x%x).",
2943 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2944 }
2945 } else {
2946 // Source image multiplane checks
2947 uint32_t planes = FormatPlaneCount(src_format);
2948 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2949 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2950 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2951 skip |= LogError(command_buffer, vuid,
2952 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2953 i, aspect);
2954 }
2955 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2956 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2957 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2958 skip |= LogError(command_buffer, vuid,
2959 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2960 i, aspect);
2961 }
2962 // Single-plane to multi-plane
2963 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2964 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2965 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2966 skip |= LogError(command_buffer, vuid,
2967 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2968 func_name, i, aspect);
2969 }
Dave Houltonc991cc92018-03-06 11:08:51 -07002970
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002971 // Dest image multiplane checks
2972 planes = FormatPlaneCount(dst_format);
2973 aspect = region.dstSubresource.aspectMask;
2974 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2975 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2976 skip |= LogError(command_buffer, vuid,
2977 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2978 i, aspect);
2979 }
2980 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2981 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2982 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2983 skip |= LogError(command_buffer, vuid,
2984 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2985 i, aspect);
2986 }
2987 // Multi-plane to single-plane
2988 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
2989 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2990 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2991 skip |= LogError(command_buffer, vuid,
2992 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2993 func_name, i, aspect);
2994 }
2995 }
2996 } else {
2997 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07002998 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2999 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003000 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003001 skip |= LogError(
3002 command_buffer, vuid,
3003 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3004 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003005 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003006 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003007
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003008 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003009 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003010 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003011 skip |=
3012 LogError(command_buffer, vuid,
3013 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3014 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003015 }
3016
3017 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003018 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003019 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003020 skip |= LogError(
3021 command_buffer, vuid,
3022 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3023 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003024 }
3025
Dave Houltonfc1a4052017-04-27 14:32:45 -06003026 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003027 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003028 if (slice_override) src_copy_extent.depth = depth_slices;
3029 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003030 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003031 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3032 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003033 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003034 "width [%1d].",
3035 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003036 }
3037
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003038 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003039 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3040 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003041 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003042 "height [%1d].",
3043 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003044 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003045 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003046 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3047 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003048 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 "depth [%1d].",
3050 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003051 }
3052
Dave Houltonee281a52017-12-08 13:51:02 -07003053 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003054 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003055 if (slice_override) dst_copy_extent.depth = depth_slices;
3056
3057 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003058 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003059 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3060 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003061 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003062 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003063 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003064 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003065 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003066 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3067 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003068 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003069 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003070 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003071 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003072 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003073 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3074 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003075 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003076 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003077 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003078 }
3079
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003080 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3081 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003082 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003083 for (uint32_t j = 0; j < regionCount; j++) {
3084 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003085 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003086 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003087 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003088 }
3089 }
3090 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003091
3092 // 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 -07003093 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003094 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3095 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3096 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003097 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3098 skip |= LogError(command_buffer, vuid,
3099 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3100 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003101 }
3102 } else {
3103 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3104 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3105 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003106 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3107 skip |= LogError(command_buffer, vuid,
3108 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3109 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003110 }
3111 }
3112
3113 // Check if 2D with 3D and depth not equal to 2D layerCount
3114 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3115 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3116 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003117 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3118 skip |= LogError(command_buffer, vuid,
3119 "%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 -08003120 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003121 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003122 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3123 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3124 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003125 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3126 skip |= LogError(command_buffer, vuid,
3127 "%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 -08003128 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003129 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003130 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003131
3132 // Check for multi-plane format compatiblity
3133 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003134 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3135 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3136 : src_format;
3137 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3138 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3139 : dst_format;
3140 const size_t src_format_size = FormatElementSize(src_plane_format);
3141 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3142
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003143 // If size is still zero, then format is invalid and will be caught in another VU
3144 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003145 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3146 skip |= LogError(command_buffer, vuid,
3147 "%s: pRegions[%u] called with non-compatible image formats. "
3148 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3149 func_name, i, string_VkFormat(src_format),
3150 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3151 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003152 }
3153 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003154 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003155
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003156 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3157 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3158 // because because both texels are 4 bytes in size.
3159 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003160 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003161 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Jeff Leger178b1e52020-10-05 12:22:23 -04003162 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3163 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003164 // Depth/stencil formats must match exactly.
3165 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3166 if (src_format != dst_format) {
3167 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003168 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003169 string_VkFormat(src_format), string_VkFormat(dst_format));
3170 }
3171 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003172 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003173 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003174 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003175 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003176 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003177 FormatElementSize(dst_format));
3178 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003179 }
3180 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003181
Dave Houlton33c22b72017-02-28 13:16:02 -07003182 // Source and dest image sample counts must match
3183 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 std::stringstream ss;
3185 ss << func_name << " called on image pair with non-identical sample counts.";
3186 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003187 skip |=
3188 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3189 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3190 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003191 }
3192
sfricke-samsung45996a42021-09-16 13:45:27 -07003193 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003194 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3195 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003196 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003197 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003198 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3199 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003200 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003201 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003202 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003203 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003204 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3205 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003206 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003207 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3208 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003209 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003210 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003211 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003212 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003213 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003214
3215 // Validation for VK_EXT_fragment_density_map
3216 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003217 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3218 skip |=
3219 LogError(command_buffer, vuid,
3220 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT", func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003221 }
3222 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003223 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3224 skip |=
3225 LogError(command_buffer, vuid,
3226 "%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 +02003227 }
3228
sfricke-samsung45996a42021-09-16 13:45:27 -07003229 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003230 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003231 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003232 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003233 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003234 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003235 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003236 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003237
3238 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003239 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003240 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3241 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3242 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003243 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003244 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3245 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3246
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003247 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003248 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003249 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003250 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3251 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003252 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003253 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003254 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
3255 &pRegions[i], i, func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003256 }
3257
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003258 return skip;
3259}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003260
Jeff Leger178b1e52020-10-05 12:22:23 -04003261bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3262 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3263 const VkImageCopy *pRegions) const {
3264 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3265 COPY_COMMAND_VERSION_1);
3266}
3267
3268bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3269 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3270 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3271 COPY_COMMAND_VERSION_2);
3272}
3273
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003274void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3275 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3276 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003277 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3278 pRegions);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003279 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3280 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3281 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003282
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003283 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003284 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003285 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3286 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003287 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003288}
3289
Jeff Leger178b1e52020-10-05 12:22:23 -04003290void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3291 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003292 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3293 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3294 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003295
3296 // Make sure that all image slices are updated to correct layout
3297 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003298 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3299 pCopyImageInfo->srcImageLayout);
3300 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3301 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003302 }
3303}
3304
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003305// Returns true if sub_rect is entirely contained within rect
3306static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3307 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 -07003308 (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 -07003309 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003310 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003311 return true;
3312}
3313
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003314bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003315 const IMAGE_VIEW_STATE* image_view_state,
3316 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003317 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003318
3319 for (uint32_t j = 0; j < rect_count; j++) {
3320 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003321 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003322 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3323 "the current render pass instance.",
3324 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003325 }
3326
3327 if (image_view_state) {
3328 // The layers specified by a given element of pRects must be contained within every attachment that
3329 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003330 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003331 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3332 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003333 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003334 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3335 "of pAttachment[%d].",
3336 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003337 }
3338 }
3339 }
3340 return skip;
3341}
3342
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003343bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3344 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003345 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003346 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003347 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003348 if (!cb_node) return skip;
3349
Jeremy Gebben9f537102021-10-05 16:37:12 -06003350 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003351
3352 // Validate that attachment is in reference list of active subpass
3353 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003354 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003355 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003356 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003357 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003358 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003359
John Zulauf3a548ef2019-02-01 16:14:07 -07003360 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3361 auto clear_desc = &pAttachments[attachment_index];
3362 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003363 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003364
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003365 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3366 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3367 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3368 attachment_index);
3369 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3370 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3371 skip |=
3372 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3373 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3374 attachment_index);
3375 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003376 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003377 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003378 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3379 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3380 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3381 skip |= LogError(
3382 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3383 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3384 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3385 attachment_index, clear_desc->colorAttachment,
3386 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3387 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003388
amhagana448ea52021-11-02 14:09:14 -04003389 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3390 }
3391 } else {
3392 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3393 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3394 " subpass %u. colorAttachmentCount=%u",
3395 attachment_index, clear_desc->colorAttachment,
3396 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3397 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003398 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003399 }
John Zulauff2582972019-02-09 14:53:30 -07003400 fb_attachment = color_attachment;
3401
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003402 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3403 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3404 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3405 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3406 "of a color attachment.",
3407 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003408 }
3409 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003410 bool subpass_depth = false;
3411 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003412 if (subpass_desc) {
3413 if (subpass_desc->pDepthStencilAttachment &&
3414 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3415 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3416 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3417 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003418 }
amhagana448ea52021-11-02 14:09:14 -04003419 if (!subpass_desc->pDepthStencilAttachment ||
3420 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3421 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3422 skip |= LogError(
3423 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3424 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3425 "depth attachment in subpass",
3426 attachment_index);
3427 }
3428 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003429 skip |= LogError(
3430 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3431 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003432 "stencil attachment in subpass",
3433 attachment_index);
3434 }
3435 } else {
3436 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003437 }
amhagana448ea52021-11-02 14:09:14 -04003438 if (subpass_depth) {
3439 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3440 "vkCmdClearAttachments()");
3441 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003442 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003443 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003444 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003445 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3446 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3447 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3448 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003449 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003450 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003451 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003452
3453 // Once the framebuffer attachment is found, can get the image view state
3454 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3455 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003456 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003457 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003458 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003459 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003460 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003461 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3462 }
3463 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003464
amhagana448ea52021-11-02 14:09:14 -04003465 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3466 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3467 for (uint32_t i = 0; i < rectCount; ++i) {
3468 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3469 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3470 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3471 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3472 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3473 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003474 }
3475 }
3476 }
John Zulauf441558b2019-08-12 11:47:39 -06003477 }
3478 return skip;
3479}
3480
3481void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3482 const VkClearAttachment *pAttachments, uint32_t rectCount,
3483 const VkClearRect *pRects) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003484 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003485 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003486 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003487 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3488 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3489 const auto clear_desc = &pAttachments[attachment_index];
3490 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3491 int image_index = -1;
3492 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3493 (clear_desc->colorAttachment < colorAttachmentCount)) {
3494 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3495 }
3496 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3497 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3498 }
3499 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3500 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3501 }
amhagana448ea52021-11-02 14:09:14 -04003502
Aaron Haganc6bafff2021-11-29 23:30:07 -05003503 if (image_index != -1) {
3504 if (!clear_rect_copy) {
3505 // We need a copy of the clear rectangles that will persist until the last lambda executes
3506 // but we want to create it as lazily as possible
3507 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003508 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003509 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3510 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3511 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3512 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3513 const FRAMEBUFFER_STATE *fb) {
3514 assert(rectCount == clear_rect_copy->size());
3515 bool skip = false;
3516 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3517 if (image_index != -1) {
3518 image_view_state = (*prim_cb->active_attachments)[image_index];
3519 }
3520 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3521 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3522 rectCount, clear_rect_copy->data());
3523 return skip;
3524 };
3525 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003526 }
amhagana448ea52021-11-02 14:09:14 -04003527 }
3528 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003529 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003530 {
3531 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3532 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003533
amhagana448ea52021-11-02 14:09:14 -04003534 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3535 const auto clear_desc = &pAttachments[attachment_index];
3536 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3537 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3538 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3539 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3540 }
3541 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3542 subpass_desc->pDepthStencilAttachment) {
3543 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3544 }
3545 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3546 if (!clear_rect_copy) {
3547 // We need a copy of the clear rectangles that will persist until the last lambda executes
3548 // but we want to create it as lazily as possible
3549 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3550 }
3551 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3552 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003553 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3554 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3555 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003556 assert(rectCount == clear_rect_copy->size());
3557 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3558 bool skip = false;
3559 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3560 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3561 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3562 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003563 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3564 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003565 return skip;
3566 };
3567 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3568 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003569 }
3570 }
3571 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003572}
3573
Jeff Leger178b1e52020-10-05 12:22:23 -04003574template <typename RegionType>
3575bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3576 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3577 const RegionType *pRegions, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003578 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3579 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
3580 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003581 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003582 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE2KHR : CMD_RESOLVEIMAGE;
3583 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003584 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003585
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003586 bool skip = false;
3587 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003588 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003589 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003590 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003591 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3592 skip |= ValidateCmd(cb_node.get(), cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003593 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003594 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003595 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003596 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003597 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003598 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003599 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003600 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003601
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003602 // Validation for VK_EXT_fragment_density_map
3603 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003604 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003605 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003606 "%s: srcImage must not have been created with flags containing "
3607 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3608 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003609 }
3610 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003612 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003613 "%s: dstImage must not have been created with flags containing "
3614 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3615 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003616 }
3617
Cort Stratton7df30962018-05-17 19:45:57 -07003618 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003619 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003620 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003621 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003622 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003623 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003624 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3625 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003626 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003627 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003628 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3629 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003630 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003631 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3632 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003633 // For each region, the number of layers in the image subresource should not be zero
3634 // For each region, src and dest image aspect must be color only
3635 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003636 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003637 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3638 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeremy Gebben9f537102021-10-05 16:37:12 -06003639 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3640 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04003641 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003642 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003643 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3644 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003645 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003646 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3647 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003648 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3649 "srcSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003650 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003651 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3652 "dstSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003653 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003654 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003655 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3656 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003657 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003658 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003659
3660 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003661 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003662 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3663 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003664 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003665 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003666 }
Cort Stratton7df30962018-05-17 19:45:57 -07003667 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003668 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3669 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003670 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003671 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003672 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3673 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003674 }
3675
3676 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3677 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3678
3679 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003680 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003681 LogObjectList objlist(cb_node->commandBuffer());
3682 objlist.add(src_image_state->image());
3683 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3685 skip |= LogError(objlist, vuid,
3686 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003687 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003688 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003689 }
3690 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003691 LogObjectList objlist(cb_node->commandBuffer());
3692 objlist.add(src_image_state->image());
3693 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003694 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3695 skip |= LogError(objlist, vuid,
3696 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003697 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003698 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003699 }
3700 }
3701
3702 if (VK_IMAGE_TYPE_1D == src_image_type) {
3703 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003704 LogObjectList objlist(cb_node->commandBuffer());
3705 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003706 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3707 skip |= LogError(objlist, vuid,
3708 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003709 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003710 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003711 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003712 }
3713 }
3714 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3715 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003716 LogObjectList objlist(cb_node->commandBuffer());
3717 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003718 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3719 skip |= LogError(objlist, vuid,
3720 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003721 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003722 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003723 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003724 }
3725 }
3726
3727 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3728 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003729 LogObjectList objlist(cb_node->commandBuffer());
3730 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003731 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3732 skip |= LogError(objlist, vuid,
3733 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003734 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003735 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003736 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003737 }
3738 }
3739 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3740 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003741 LogObjectList objlist(cb_node->commandBuffer());
3742 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003743 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3744 skip |= LogError(objlist, vuid,
3745 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003746 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003747 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003748 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003749 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003750 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003751
3752 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003753 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003754 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3755 // developer
3756 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3757 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003758 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003759 LogObjectList objlist(cb_node->commandBuffer());
3760 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003761 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3762 skip |= LogError(objlist, vuid,
3763 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003764 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003765 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003766 region.extent.width, subresource_extent.width);
3767 }
3768
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003769 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003770 LogObjectList objlist(cb_node->commandBuffer());
3771 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3773 skip |= LogError(objlist, vuid,
3774 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003775 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003776 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003777 region.extent.height, subresource_extent.height);
3778 }
3779
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003780 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003781 LogObjectList objlist(cb_node->commandBuffer());
3782 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3784 skip |= LogError(objlist, vuid,
3785 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003786 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003787 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003788 region.extent.depth, subresource_extent.depth);
3789 }
3790 }
3791
3792 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003793 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003794 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3795 // developer
3796 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3797 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003798 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003799 LogObjectList objlist(cb_node->commandBuffer());
3800 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003801 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3802 skip |= LogError(objlist, vuid,
3803 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003804 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003805 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003806 region.extent.width, subresource_extent.width);
3807 }
3808
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003809 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003810 LogObjectList objlist(cb_node->commandBuffer());
3811 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003812 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3813 skip |= LogError(objlist, vuid,
3814 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003815 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003816 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003817 region.extent.height, subresource_extent.height);
3818 }
3819
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003820 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003821 LogObjectList objlist(cb_node->commandBuffer());
3822 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3824 skip |= LogError(objlist, vuid,
3825 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003826 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003827 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003828 region.extent.depth, subresource_extent.depth);
3829 }
3830 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003831 }
3832
3833 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003834 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003835 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 -04003836 func_name, string_VkFormat(src_image_state->createInfo.format),
3837 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003838 }
3839 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003840 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003841 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003842 string_VkImageType(src_image_state->createInfo.imageType),
3843 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003844 }
3845 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003846 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003847 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 -07003848 }
3849 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003850 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003851 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 -04003852 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003853 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003854 } else {
3855 assert(0);
3856 }
3857 return skip;
3858}
3859
Jeff Leger178b1e52020-10-05 12:22:23 -04003860bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3861 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3862 const VkImageResolve *pRegions) const {
3863 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3864 COPY_COMMAND_VERSION_1);
3865}
3866
3867bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3868 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3869 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3870 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3871 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3872}
3873
3874template <typename RegionType>
3875bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3876 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3877 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003878 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3879 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
3880 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003881
Jeff Leger178b1e52020-10-05 12:22:23 -04003882 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003883 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE2KHR : CMD_BLITIMAGE;
3884 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003885
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003886 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003887 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003888 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07003889 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003890 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003891 const char *vuid;
3892 const char *location;
3893 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3894 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003895 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003896 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3897 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003898 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003899 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003900 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003901 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003902 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003903 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003904 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003905 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3906 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003907 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003908 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003909 skip |= ValidateCmd(cb_node.get(), cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003910 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003911 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003913 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003914 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003915 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003916 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003917 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003919 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003920
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003921 // Validation for VK_EXT_fragment_density_map
3922 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003923 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003924 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003925 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3926 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003927 }
3928 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003930 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003931 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3932 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003933 }
3934
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003935 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003936
Dave Houlton33c2d252017-06-09 17:08:32 -06003937 VkFormat src_format = src_image_state->createInfo.format;
3938 VkFormat dst_format = dst_image_state->createInfo.format;
3939 VkImageType src_type = src_image_state->createInfo.imageType;
3940 VkImageType dst_type = dst_image_state->createInfo.imageType;
3941
Cort Stratton186b1a22018-05-01 20:18:06 -04003942 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003943 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003944 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
3945 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003946 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003947 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003948 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003949 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003950 }
3951
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003952 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003953 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04003954 skip |= LogError(device, vuid,
3955 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003956 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003957 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003958 }
3959
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003960 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003961 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04003962 skip |= LogError(device, vuid,
3963 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003964 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003965 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003966 }
3967
ziga-lunarg52604a12021-09-09 16:02:05 +02003968 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003969 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003970 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02003971 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003972 }
3973
Dave Houlton33c2d252017-06-09 17:08:32 -06003974 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08003975 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003976 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003977 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003978 << "the other one must also have unsigned integer format. "
3979 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003980 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003981 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003982 }
3983
3984 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08003985 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003986 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003987 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003988 << "the other one must also have signed integer format. "
3989 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003990 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003991 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003992 }
3993
3994 // Validate filter for Depth/Stencil formats
3995 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3996 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003997 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003998 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003999 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004000 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004001 }
4002
4003 // Validate aspect bits and formats for depth/stencil images
4004 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4005 if (src_format != dst_format) {
4006 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004007 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 -06004008 << "stencil, the other one must have exactly the same format. "
4009 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4010 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004011 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004012 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004013 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004014 } // Depth or Stencil
4015
4016 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004017 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004018 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4020 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004021 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4023 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004024 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004025 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004026 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4027 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004028 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004029 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4030 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004031 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004032 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004033 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004034 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004035 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004038 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004039 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06004040 skip |= ValidateImageSubresourceLayers(cb_node.get(), &rgn.srcSubresource, func_name, "srcSubresource", i);
4041 skip |= ValidateImageSubresourceLayers(cb_node.get(), &rgn.dstSubresource, func_name, "dstSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04004042 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004043 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), rgn.srcSubresource.mipLevel, i, func_name,
4044 "srcSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04004045 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004046 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), rgn.dstSubresource.mipLevel, i, func_name,
4047 "dstSubresource", vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04004048 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004049 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004050 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4051 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004052 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004054 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004055 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4056 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004057 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004058 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004059 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004060 }
Dave Houlton48989f32017-05-26 15:01:46 -06004061 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4062 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004063 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004064 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004065 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004066 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004067
4068 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004069 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004070 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4071 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004072 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004073 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004074 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004075
Dave Houlton48989f32017-05-26 15:01:46 -06004076 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004077 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4078 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004079 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004080 }
Dave Houlton48989f32017-05-26 15:01:46 -06004081
Dave Houlton33c2d252017-06-09 17:08:32 -06004082 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004083 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004084 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004085 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004086 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004087 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004088 }
4089
4090 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004091 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004092 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004093 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4094 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004095 }
4096
Dave Houlton48989f32017-05-26 15:01:46 -06004097 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004098 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004099 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004100 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004101 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004102 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004103 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4104 "of (%1d, %1d). These must be (0, 1).",
4105 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004106 }
4107 }
4108
Dave Houlton33c2d252017-06-09 17:08:32 -06004109 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004110 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004111 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004112 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004113 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4114 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4115 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004116 }
4117 }
4118
Dave Houlton33c2d252017-06-09 17:08:32 -06004119 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004120 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4121 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004122 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004123 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004124 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004125 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4126 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004127 }
4128 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4129 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004130 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004131 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004132 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004133 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4134 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004135 }
4136 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4137 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004138 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004139 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004140 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004141 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4142 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004143 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004144 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004145 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004146 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004147 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004148 }
Dave Houlton48989f32017-05-26 15:01:46 -06004149
4150 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004151 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004152 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004153 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004154 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004155 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004156 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4157 "(%1d, %1d). These must be (0, 1).",
4158 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004159 }
4160 }
4161
Dave Houlton33c2d252017-06-09 17:08:32 -06004162 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004163 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004164 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004165 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004166 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004167 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004168 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004169 }
4170 }
4171
Dave Houlton33c2d252017-06-09 17:08:32 -06004172 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004173 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4174 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004175 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004176 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004177 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004178 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4179 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004180 }
4181 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4182 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004183 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004184 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004185 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004186 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4187 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004188 }
4189 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4190 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004191 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004192 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004193 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004194 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4195 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004196 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004197 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004198 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004199 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004200 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004201 }
4202
Dave Houlton33c2d252017-06-09 17:08:32 -06004203 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4204 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4205 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004206 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004207 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004208 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4209 "layerCount other than 1.",
4210 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004211 }
4212 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004213 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004214 } else {
4215 assert(0);
4216 }
4217 return skip;
4218}
4219
Jeff Leger178b1e52020-10-05 12:22:23 -04004220bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4221 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4222 const VkImageBlit *pRegions, VkFilter filter) const {
4223 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4224 COPY_COMMAND_VERSION_1);
4225}
4226
4227bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4228 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4229 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4230 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4231}
4232
4233template <typename RegionType>
4234void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4235 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4236 VkFilter filter) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004237 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
4238 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4239 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004240
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004241 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004242 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004243 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4244 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004245 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004246}
4247
Jeff Leger178b1e52020-10-05 12:22:23 -04004248void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4249 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4250 const VkImageBlit *pRegions, VkFilter filter) {
4251 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4252 pRegions, filter);
4253 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4254}
4255
4256void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4257 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4258 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4259 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4260 pBlitImageInfo->filter);
4261}
4262
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004263GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004264 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004265 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004266 if (!layout_map) {
4267 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004268 }
John Zulauf17708d02021-02-22 11:20:58 -07004269 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004270}
4271
Jeremy Gebben6335df62021-11-01 10:50:13 -06004272const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4273 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004274 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004275 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004276 }
4277 return nullptr;
4278}
4279
Jeremy Gebben53631302021-04-13 16:46:37 -06004280// Helper to update the Global or Overlay layout map
4281struct GlobalLayoutUpdater {
4282 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4283 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4284 dst = src.current_layout;
4285 return true;
4286 }
4287 return false;
4288 }
4289
4290 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4291 layer_data::optional<VkImageLayout> result;
4292 if (src.current_layout != image_layout_map::kInvalidLayout) {
4293 result.emplace(src.current_layout);
4294 }
4295 return result;
4296 }
4297};
4298
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004299// 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 -07004300bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
4301 const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004302 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004303 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004304 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004305 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004306 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004307 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004308 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004309 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004310 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004311 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004312 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004313
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004314 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben6335df62021-11-01 10:50:13 -06004315 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004316 if (global_map == nullptr) {
4317 global_map = &empty_map;
4318 }
4319
4320 // Note: don't know if it would matter
4321 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4322
Jeremy Gebben53631302021-04-13 16:46:37 -06004323 auto pos = layout_map.begin();
4324 const auto end = layout_map.end();
4325 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4326 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004327 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004328 VkImageLayout initial_layout = pos->second.initial_layout;
4329 assert(initial_layout != image_layout_map::kInvalidLayout);
4330 if (initial_layout == image_layout_map::kInvalidLayout) {
4331 continue;
4332 }
4333
John Zulauf2076e812020-01-08 14:55:54 -07004334 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004335
John Zulauf2076e812020-01-08 14:55:54 -07004336 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 -07004337 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004338 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004339 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004340 image_layout = current_layout->pos_B->lower_bound->second;
4341 }
4342 const auto intersected_range = pos->first & current_layout->range;
4343 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4344 // TODO: Set memory invalid which is in mem_tracker currently
4345 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004346 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4347 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004348 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004349 // We can report all the errors for the intersected range directly
4350 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004351 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004352 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004353 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004354 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004355 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004356 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004357 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004358 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004359 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004360 }
4361 }
John Zulauf2076e812020-01-08 14:55:54 -07004362 if (pos->first.includes(intersected_range.end)) {
4363 current_layout.seek(intersected_range.end);
4364 } else {
4365 ++pos;
4366 if (pos != end) {
4367 current_layout.seek(pos->first.begin);
4368 }
4369 }
John Zulauff660ad62019-03-23 07:16:05 -06004370 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004371 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004372 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004373 }
John Zulauff660ad62019-03-23 07:16:05 -06004374
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004375 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004376}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004377
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004378void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004379 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004380 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004381 const auto &subres_map = layout_map_entry.second;
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004382 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004383 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004384 }
4385}
4386
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004387// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004388// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4389// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004390bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4391 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004392 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004393 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004394 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4395
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004396 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004397 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4398 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004399 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004400 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4401 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4402 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004403 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004404 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004405 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004406 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004407 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4408 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004409 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004410 string_VkImageLayout(first_layout));
4411 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4412 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004413 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004414 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004415 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004416 }
4417 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004418
4419 // Same as above for loadOp, but for stencilLoadOp
4420 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4421 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4422 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4423 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4424 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004425 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004426 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004427 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004428 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4429 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004430 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004431 string_VkImageLayout(first_layout));
4432 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4433 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4434 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004435 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004436 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004437 }
4438 }
4439
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004440 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004441}
4442
Mark Lobodzinski96210742017-02-09 10:33:46 -07004443// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4444// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004445template <typename T1>
4446bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4447 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4448 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004449 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004450 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004451 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004452 if (strict) {
4453 correct_usage = ((actual & desired) == desired);
4454 } else {
4455 correct_usage = ((actual & desired) != 0);
4456 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004457
Mark Lobodzinski96210742017-02-09 10:33:46 -07004458 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004459 // All callers should have a valid VUID
4460 assert(msgCode != kVUIDUndefined);
4461 skip =
4462 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4463 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004464 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004465 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004466}
4467
4468// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4469// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004470bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004471 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004472 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004473 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004474}
4475
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004476bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004477 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004478 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004479 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4480 if ((image_format_features & desired) != desired) {
4481 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004482 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004483 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004484 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4485 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4486 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004487 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004488 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004489 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004490 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4491 "with tiling %s.",
4492 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004493 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004494 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004495 }
4496 }
4497 return skip;
4498}
4499
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004500bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004501 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004502 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004503 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004504 // layerCount must not be zero
4505 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004506 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004507 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004508 }
4509 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004510 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004511 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004512 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004513 }
4514 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004515 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 -06004516 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004517 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4518 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4519 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004520 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004521 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4522 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4523 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004524 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004525 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4526 member);
4527 }
Cort Strattond619a302018-05-17 19:46:32 -07004528 return skip;
4529}
4530
Mark Lobodzinski96210742017-02-09 10:33:46 -07004531// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4532// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004533bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004534 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004535 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004536 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004537}
4538
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004539bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004540 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004541 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004542
4543 const VkDeviceSize &range = pCreateInfo->range;
4544 if (range != VK_WHOLE_SIZE) {
4545 // Range must be greater than 0
4546 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004547 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004548 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004549 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4550 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004551 }
4552 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004553 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4554 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004555 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004556 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004557 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4558 "(%" PRIu32 ").",
4559 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004560 }
4561 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004562 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004563 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004564 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004565 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4566 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4567 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004568 }
4569 // The sum of range and offset must be less than or equal to the size of buffer
4570 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004571 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
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, the sum of offset (%" PRIuLEAST64
4574 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4575 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004576 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004577 } else {
4578 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4579
4580 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4581 // VkPhysicalDeviceLimits::maxTexelBufferElements
4582 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4583 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004584 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004585 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4586 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4587 "), divided by the element size of the format (%" PRIu32
4588 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4589 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4590 device_limits->maxTexelBufferElements);
4591 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004592 }
4593 return skip;
4594}
4595
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004596bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004597 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004598 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004599 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4600 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004601 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004602 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004603 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4604 "be supported for uniform texel buffers",
4605 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004606 }
4607 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4608 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004609 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004610 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004611 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4612 "be supported for storage texel buffers",
4613 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004614 }
4615 return skip;
4616}
4617
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004618bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004619 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004620 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004621
Dave Houltond8ed0212018-05-16 17:18:24 -06004622 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004623
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004624 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004625 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004626 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004627 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004628 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4629 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004630 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004631 }
4632 }
4633
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004634 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004635 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004636 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004637 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004638 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004639 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4640 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004641 }
4642 }
4643
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004644 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4645 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4646 if (pCreateInfo->flags &
4647 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4648 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4649 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4650 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4651 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4652 }
4653 }
4654
Mike Schuchardt2df08912020-12-15 16:28:09 -08004655 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004656 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004657 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004658 skip |= LogError(
4659 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004660 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004661 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004662 }
4663
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004664 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004665 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4666 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4667 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004668 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004669 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004670 }
4671
sfricke-samsungedce77a2020-07-03 22:35:13 -07004672 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4673 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4674 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4675 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4676 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4677 }
4678 const VkBufferCreateFlags invalid_flags =
4679 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4680 if ((pCreateInfo->flags & invalid_flags) != 0) {
4681 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4682 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4683 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4684 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4685 }
4686 }
4687
Mark Lobodzinski96210742017-02-09 10:33:46 -07004688 return skip;
4689}
4690
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004691bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004692 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004693 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004694 const auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004695
4696 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4697 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4698 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4699 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4700 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4701 "defined sizes for alignment, replace with a color format.",
4702 string_VkFormat(pCreateInfo->format));
4703 }
4704
Mark Lobodzinski96210742017-02-09 10:33:46 -07004705 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4706 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004707 skip |=
4708 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004709 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4710 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06004711 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06004712 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4713 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4714 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004715
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004716 // Buffer view offset must be less than the size of buffer
4717 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004718 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004719 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004720 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4721 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004722 }
4723
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004724 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004725 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4726 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4727 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004728 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4729 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4730 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004731 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004732 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004733 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4734 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004735 }
4736
4737 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004738 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4739 if ((element_size % 3) == 0) {
4740 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004741 }
4742 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004743 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004744 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4745 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004746 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004747 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004748 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004749 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004750 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004751 "vkCreateBufferView(): If buffer was created with usage containing "
4752 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004753 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4754 ") must be a multiple of the lesser of "
4755 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4756 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4757 "(%" PRId32
4758 ") is VK_TRUE, the size of a texel of the requested format. "
4759 "If the size of a texel is a multiple of three bytes, then the size of a "
4760 "single component of format is used instead",
4761 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4762 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4763 }
4764 }
4765 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004766 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004767 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4768 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004769 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004770 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004771 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004772 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004773 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004774 "vkCreateBufferView(): If buffer was created with usage containing "
4775 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004776 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4777 ") must be a multiple of the lesser of "
4778 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4779 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4780 "(%" PRId32
4781 ") is VK_TRUE, the size of a texel of the requested format. "
4782 "If the size of a texel is a multiple of three bytes, then the size of a "
4783 "single component of format is used instead",
4784 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4785 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4786 }
4787 }
4788 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004789
Jeremy Gebben9f537102021-10-05 16:37:12 -06004790 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004791
Jeremy Gebben9f537102021-10-05 16:37:12 -06004792 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004793 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004794 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004795}
4796
Mark Lobodzinski602de982017-02-09 11:01:33 -07004797// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004798bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004799 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004800 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004801 const auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung79b00482020-04-01 21:15:50 -07004802 // checks color format and (single-plane or non-disjoint)
4803 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004804 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004805 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004806 skip |= LogError(
4807 image, vuid,
4808 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4809 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004810 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004811 skip |= LogError(image, vuid,
4812 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4813 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4814 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004815 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004816 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004817 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004818 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004819 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4820 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4821 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004822 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004823 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004824 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4825 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4826 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004827 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004828 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004829 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004830 skip |= LogError(image, vuid,
4831 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4832 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4833 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004834 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_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 depth-only image formats can have only the "
4837 "VK_IMAGE_ASPECT_DEPTH_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 (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004841 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004842 skip |= LogError(image, vuid,
4843 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4844 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4845 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004846 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004847 skip |= LogError(image, vuid,
4848 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4849 "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 Houlton501b15b2018-03-30 15:07:41 -06004852 } else if (FormatIsMultiplane(format)) {
4853 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4854 if (3 == FormatPlaneCount(format)) {
4855 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4856 }
4857 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004858 skip |= LogError(image, vuid,
4859 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4860 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4861 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004862 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004863 }
4864 return skip;
4865}
4866
ziga-lunarg04e94b32021-10-03 01:42:37 +02004867bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
4868 bool skip = false;
4869
ziga-lunarg04e94b32021-10-03 01:42:37 +02004870 return skip;
4871}
4872
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004873bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4874 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004875 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004876 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004877 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004878
4879 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004880 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004881 skip |= LogError(image, errorCodes.base_mip_err,
4882 "%s: %s.baseMipLevel (= %" PRIu32
4883 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4884 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004885 }
Petr Kraus4d718682017-05-18 03:38:41 +02004886
Petr Krausffa94af2017-08-08 21:46:02 +02004887 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4888 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004889 skip |=
4890 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004891 } else {
4892 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004893
Petr Krausffa94af2017-08-08 21:46:02 +02004894 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004895 skip |= LogError(image, errorCodes.mip_count_err,
4896 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4897 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4898 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4899 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004900 }
Petr Kraus4d718682017-05-18 03:38:41 +02004901 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004902 }
Petr Kraus4d718682017-05-18 03:38:41 +02004903
4904 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004905 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004906 skip |= LogError(image, errorCodes.base_layer_err,
4907 "%s: %s.baseArrayLayer (= %" PRIu32
4908 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4909 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004910 }
Petr Kraus4d718682017-05-18 03:38:41 +02004911
Petr Krausffa94af2017-08-08 21:46:02 +02004912 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4913 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004914 skip |=
4915 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004916 } else {
4917 const uint64_t necessary_layer_count =
4918 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004919
Petr Krausffa94af2017-08-08 21:46:02 +02004920 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004921 skip |= LogError(image, errorCodes.layer_count_err,
4922 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4923 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4924 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4925 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004926 }
Petr Kraus4d718682017-05-18 03:38:41 +02004927 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004928 }
Petr Kraus4d718682017-05-18 03:38:41 +02004929
ziga-lunargb4e90752021-08-02 13:58:29 +02004930 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4931 if (subresourceRange.aspectMask &
4932 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4933 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4934 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4935 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4936 cmd_name);
4937 }
4938 }
4939
Mark Lobodzinski602de982017-02-09 11:01:33 -07004940 return skip;
4941}
4942
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004943bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004944 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004945 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004946 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004947 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004948 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 +02004949
David McFarland2853f2f2020-11-30 15:50:39 -04004950 uint32_t image_layer_count;
4951
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004952 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004953 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004954 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004955 image_layer_count = extent.depth;
4956 } else {
4957 image_layer_count = image_state->createInfo.arrayLayers;
4958 }
4959
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004960 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004961
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004962 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4963 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4964 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4965 subresource_range_error_codes.base_layer_err =
4966 is_khr_maintenance1
4967 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4968 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4969 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4970 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4971 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4972 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004973
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004974 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004975 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004976 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004977}
4978
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004979bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004980 const VkImageSubresourceRange &subresourceRange,
4981 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004982 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4983 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4984 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4985 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4986 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004987
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004988 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004989 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004990 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004991}
4992
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004993bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004994 const VkImageSubresourceRange &subresourceRange,
4995 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004996 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4997 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4998 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4999 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5000 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005001
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005002 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005003 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005004 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005005}
5006
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005007bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005008 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005009 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005010 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005011 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005012}
5013
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005014namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005015using sync_vuid_maps::GetBarrierQueueVUID;
5016using sync_vuid_maps::kQueueErrorSummary;
5017using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005018
5019class ValidatorState {
5020 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005021 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005022 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5023 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005024 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005025 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005026 barrier_handle_(barrier_handle),
5027 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005028 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5029 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5030
5031 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5032 // 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 -07005033 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5034 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005035 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005036 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5037 loc_.Message().c_str(), GetTypeString(),
5038 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5039 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005040 }
5041
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005042 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5043 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005044 const char *src_annotation = GetFamilyAnnotation(src_family);
5045 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5046 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005047 objects_, val_code,
5048 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5049 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5050 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005051 }
5052
5053 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5054 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5055 // application input.
5056 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5057 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005058 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005059 uint32_t queue_family = queue_state->queueFamilyIndex;
5060 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005061 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005062 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5063 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5064 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005065 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005066 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005067 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005068 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005069 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005070 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005071 }
5072 return false;
5073 }
5074 // Logical helpers for semantic clarity
5075 inline bool KhrExternalMem() const { return mem_ext_; }
5076 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5077 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5078 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5079 }
5080
5081 // Helpers for LogMsg
5082 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5083
5084 // Descriptive text for the various types of queue family index
5085 const char *GetFamilyAnnotation(uint32_t family) const {
5086 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5087 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5088 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5089 const char *valid = " (VALID)";
5090 const char *invalid = " (INVALID)";
5091 switch (family) {
5092 case VK_QUEUE_FAMILY_EXTERNAL:
5093 return external;
5094 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5095 return foreign;
5096 case VK_QUEUE_FAMILY_IGNORED:
5097 return ignored;
5098 default:
5099 if (IsValid(family)) {
5100 return valid;
5101 }
5102 return invalid;
5103 };
5104 }
5105 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5106 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5107
5108 protected:
5109 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005110 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005111 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005112 const VulkanTypedHandle barrier_handle_;
5113 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005114 const uint32_t limit_;
5115 const bool mem_ext_;
5116};
5117
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005118bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005119 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5120 bool skip = false;
5121
5122 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5123 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5124 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5125 if (val.KhrExternalMem()) {
5126 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005127 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5128 // this requirement is removed by VK_KHR_synchronization2
5129 if (!(src_ignored || dst_ignored) && !sync2) {
5130 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005131 }
5132 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5133 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005134 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005135 }
5136 } else {
5137 // VK_SHARING_MODE_EXCLUSIVE
5138 if (src_queue_family != dst_queue_family) {
5139 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005140 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005141 }
5142 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005143 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005144 }
5145 }
5146 }
5147 } else {
5148 // No memory extension
5149 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005150 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5151 // this requirement is removed by VK_KHR_synchronization2
5152 if ((!src_ignored || !dst_ignored) && !sync2) {
5153 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005154 }
5155 } else {
5156 // VK_SHARING_MODE_EXCLUSIVE
5157 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005158 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005159 }
5160 }
5161 }
5162 return skip;
5163}
5164} // namespace barrier_queue_families
5165
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005166bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5167 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005168 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5169 uint32_t dst_queue_family) {
5170 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005171 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5172 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005173}
5174
5175// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005176template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005177bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5178 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005179 // State data is required
5180 if (!state_data) {
5181 return false;
5182 }
5183
5184 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005185 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005186 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005187 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5188 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005189 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005190}
5191
5192// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005193template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005194bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5195 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005196 // State data is required
5197 if (!state_data) {
5198 return false;
5199 }
5200
5201 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005202 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005203 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005204 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5205 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005206 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5207}
5208
5209template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005210bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005211 const Barrier &mem_barrier) const {
5212 using sync_vuid_maps::BufferError;
5213 using sync_vuid_maps::GetBufferBarrierVUID;
5214
5215 bool skip = false;
5216
5217 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5218
5219 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005220 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005221 if (buffer_state) {
5222 auto buf_loc = loc.dot(Field::buffer);
5223 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005224 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005225
Jeremy Gebben9f537102021-10-05 16:37:12 -06005226 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005227
5228 auto buffer_size = buffer_state->createInfo.size;
5229 if (mem_barrier.offset >= buffer_size) {
5230 auto offset_loc = loc.dot(Field::offset);
5231 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5232
5233 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5234 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5235 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5236 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5237 auto size_loc = loc.dot(Field::size);
5238 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5239 skip |= LogError(objects, vuid,
5240 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5241 ".",
5242 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5243 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5244 }
5245 if (mem_barrier.size == 0) {
5246 auto size_loc = loc.dot(Field::size);
5247 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5248 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5249 report_data->FormatHandle(mem_barrier.buffer).c_str());
5250 }
5251 }
5252 return skip;
5253}
5254
5255template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005256bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005257 const Barrier &mem_barrier) const {
5258 bool skip = false;
5259
5260 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5261
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005262 bool is_ilt = true;
5263 if (enabled_features.synchronization2_features.synchronization2) {
5264 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5265 }
5266
5267 if (is_ilt) {
5268 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5269 auto layout_loc = loc.dot(Field::newLayout);
5270 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5271 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005272 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005273 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005274 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005275 }
5276
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005277 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005278 if (image_data) {
5279 auto image_loc = loc.dot(Field::image);
5280
Jeremy Gebben9f537102021-10-05 16:37:12 -06005281 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005282
Jeremy Gebben9f537102021-10-05 16:37:12 -06005283 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005284
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005285 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005286 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005287
Jeremy Gebben9f537102021-10-05 16:37:12 -06005288 skip |=
5289 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg04e94b32021-10-03 01:42:37 +02005290 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005291 }
5292 return skip;
5293}
5294
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005295bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5296 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5297 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005298 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5299 const VkImageMemoryBarrier *pImageMemBarriers) const {
5300 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005301 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005302
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005303 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5304 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005305 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005306 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005307 }
5308 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5309 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005310 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005311 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005312 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5313 }
5314 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005315 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005316 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5317 }
5318 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5319 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005320 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005321 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005322 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5323 }
5324 return skip;
5325}
5326
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005327bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005328 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005329 bool skip = false;
5330
5331 if (cb_state->activeRenderPass) {
5332 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5333 if (skip) return true; // Early return to avoid redundant errors from below calls
5334 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005335 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5336 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005337 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005338 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005339 }
5340 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5341 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005342 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005343 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005344 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5345 }
5346 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005347 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005348 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5349 }
5350
5351 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5352 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005353 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005354 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005355 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5356 }
5357
5358 return skip;
5359}
5360
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005361// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005362template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005363bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5364 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005365 VkPipelineStageFlags dst_stage_mask) const {
5366 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005367 assert(cb_state);
5368 auto queue_flags = cb_state->GetQueueFlags();
5369
5370 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005371 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5372 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005373 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005374 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5375 }
5376 return skip;
5377}
5378
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005379// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005380template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005381bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5382 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005383 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005384 assert(cb_state);
5385 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005386
Jeremy Gebbenefead332021-06-18 08:22:44 -06005387 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005388 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005389 skip |=
5390 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5391 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005392
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005393 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005394 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005395 skip |=
5396 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5397 }
5398 return skip;
5399}
5400
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005401// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5402// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5403// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5404static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5405 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5406}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005407
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005408bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5409 const VkSubpassDependency2 &dependency) const {
5410 bool skip = false;
5411 Location loc = in_loc;
5412 VkMemoryBarrier2KHR converted_barrier;
5413 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5414
5415 if (mem_barrier && enabled_features.synchronization2_features.synchronization2) {
5416 if (dependency.srcAccessMask != 0) {
5417 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5418 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5419 loc.dot(Field::srcAccessMask).Message().c_str());
5420 }
5421 if (dependency.dstAccessMask != 0) {
5422 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5423 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5424 loc.dot(Field::dstAccessMask).Message().c_str());
5425 }
5426 if (dependency.srcStageMask != 0) {
5427 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5428 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5429 loc.dot(Field::srcStageMask).Message().c_str());
5430 }
5431 if (dependency.dstStageMask != 0) {
5432 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5433 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5434 loc.dot(Field::dstStageMask).Message().c_str());
5435 }
5436 loc = in_loc.dot(Field::pNext);
5437 converted_barrier = *mem_barrier;
5438 } else {
5439 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005440 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5441 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5442 loc.Message().c_str());
5443 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005444 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5445 converted_barrier.srcStageMask = dependency.srcStageMask;
5446 converted_barrier.dstStageMask = dependency.dstStageMask;
5447 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5448 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005449 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005450 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5451 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5452 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5453 converted_barrier.srcStageMask);
5454
5455 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5456 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5457 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5458 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005459 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005460}
5461
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005462bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5463 const VkImageUsageFlags image_usage) const {
5464 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5465 bool skip = false;
5466
5467 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5468 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5469
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005470 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005471 // AHB image view and image share same feature sets
5472 tiling_features = image_state->format_features;
5473 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5474 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005475 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005476 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5477 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005478 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005479
5480 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5481 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5482 nullptr};
5483 format_properties_2.pNext = (void *)&drm_properties_list;
5484 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5485
nyorain38a9d232021-03-06 13:06:12 +01005486 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5487 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5488 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5489
5490 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5491
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005492 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5493 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5494 0) {
5495 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5496 }
5497 }
5498 } else {
5499 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5500 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5501 : format_properties.optimalTilingFeatures;
5502 }
5503
5504 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005505 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005506 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5507 "physical device.",
5508 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5509 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005510 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005511 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5512 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5513 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5514 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005515 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005516 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5517 "VK_IMAGE_USAGE_STORAGE_BIT.",
5518 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5519 } 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 -06005520 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005521 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5522 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5523 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5524 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5525 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005526 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005527 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5528 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5529 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5530 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5531 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005532 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005533 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5534 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5535 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005536 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5537 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5538 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005539 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005540 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5541 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5542 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5543 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005544 }
5545
5546 return skip;
5547}
5548
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005549bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005550 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005551 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005552 const auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005553 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005554 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005555 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005556 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5557 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005558 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5559 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5560 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005561 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005562 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005563 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005564 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005565 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005566 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005567 image_state.get(),
5568 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005569 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005570
5571 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5572 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005573 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005574 VkFormat view_format = pCreateInfo->format;
5575 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005576 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005577 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005578 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005579
Dave Houltonbd2e2622018-04-10 16:41:14 -06005580 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005581 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005582 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005583 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5584 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005585 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005586 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5587 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5588 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005589 }
5590 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005591 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005592 if (image_stencil_struct == nullptr) {
5593 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005594 skip |= LogError(
5595 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005596 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5597 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5598 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5599 }
5600 } else {
5601 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5602 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5603 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005604 skip |= LogError(
5605 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005606 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5607 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5608 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5609 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5610 }
5611 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5612 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005613 skip |= LogError(
5614 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005615 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5616 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5617 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5618 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5619 }
5620 }
5621 }
5622 }
5623
Dave Houltonbd2e2622018-04-10 16:41:14 -06005624 image_usage = chained_ivuci_struct->usage;
5625 }
5626
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005627 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5628 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5629 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5630 bool foundFormat = false;
5631 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5632 if (format_list_info->pViewFormats[i] == view_format) {
5633 foundFormat = true;
5634 break;
5635 }
5636 }
5637 if (foundFormat == false) {
5638 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5639 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5640 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5641 string_VkFormat(view_format));
5642 }
5643 }
5644
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005645 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5646 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005647 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005648 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005649 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005650 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005651 std::stringstream ss;
5652 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005653 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005654 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005655 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005656 }
5657 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005658 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005659 // 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 -06005660 auto image_class = FormatCompatibilityClass(image_format);
5661 auto view_class = FormatCompatibilityClass(view_format);
5662 // Need to only check if one is NONE to handle edge case both are NONE
5663 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005664 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005665 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5666 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005667 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005668 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5669 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005670 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005671 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5672 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005673 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5674 } else {
5675 // both enabled
5676 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5677 }
Dave Houltonc7988072018-04-16 11:46:56 -06005678 std::stringstream ss;
5679 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005680 << " is not in the same format compatibility class as "
5681 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005682 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5683 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005684 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005685 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005686 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005687 }
5688 } else {
5689 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005690 // Unless it is a multi-planar color bit aspect
5691 if ((image_format != view_format) &&
5692 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005693 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5694 ? "VUID-VkImageViewCreateInfo-image-01762"
5695 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005696 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005697 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005698 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005699 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005700 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005701 }
5702 }
5703
ziga-lunargebb32de2021-08-29 21:24:30 +02005704 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5705 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5706 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5707 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5708 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5709 }
5710
Mark Lobodzinski602de982017-02-09 11:01:33 -07005711 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005712 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005713
sfricke-samsung20a8a372021-07-14 06:12:17 -07005714 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005715 switch (image_type) {
5716 case VK_IMAGE_TYPE_1D:
5717 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005718 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5719 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5720 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005721 }
5722 break;
5723 case VK_IMAGE_TYPE_2D:
5724 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5725 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5726 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005727 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5728 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5729 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005730 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005731 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5732 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5733 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005734 }
5735 }
5736 break;
5737 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005738 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005739 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5740 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005741 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005742 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005743 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005744 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5745 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005746 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005747 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5748 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005749 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005750 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005751 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5752 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5753 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5754 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005755 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5756 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5757 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5758 "levelCount of 1 but it is %u.",
5759 string_VkImageViewType(view_type), string_VkImageType(image_type),
5760 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005761 }
5762 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005763 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5764 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5765 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005766 }
5767 }
5768 } else {
5769 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005770 // Help point to VK_KHR_maintenance1
5771 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5772 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5773 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5774 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5775 string_VkImageViewType(view_type), string_VkImageType(image_type));
5776 } else {
5777 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5778 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5779 string_VkImageViewType(view_type), string_VkImageType(image_type));
5780 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005781 }
5782 }
5783 break;
5784 default:
5785 break;
5786 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005787
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005788 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005789 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005790 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005791 }
5792
Jeremy Gebben9f537102021-10-05 16:37:12 -06005793 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005794
sfricke-samsung828e59d2021-08-22 23:20:49 -07005795 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005796 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5797 if (view_format != VK_FORMAT_R8_UINT) {
5798 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5799 "vkCreateImageView() If image was created with usage containing "
5800 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5801 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005802 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005803 }
5804
sfricke-samsung828e59d2021-08-22 23:20:49 -07005805 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00005806 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5807 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5808 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5809 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5810 "vkCreateImageView() If image was created with usage containing "
5811 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5812 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5813 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005814 }
5815 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005816
Tobias Hector6663c9b2020-11-05 10:18:02 +00005817 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5818 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005819 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005820 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5821 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005822 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005823 }
5824
sfricke-samsung20a8a372021-07-14 06:12:17 -07005825 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5826 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5827 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005828 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5829 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005830 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005831 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005832 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005833 skip |= LogError(
5834 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5835 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005836 remaining_layers);
5837 }
5838 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5839 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5840 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5841 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5842 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5843 string_VkImageViewType(view_type), remaining_layers);
5844 }
5845 } else {
5846 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5847 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5848 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5849 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5850 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5851 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005852 }
5853 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005854
5855 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5856 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005857 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005858 "vkCreateImageView(): If image was created with usage containing "
5859 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5860 pCreateInfo->subresourceRange.levelCount);
5861 }
5862 }
5863 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5864 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005865 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005866 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5867 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5868 }
5869 } else {
5870 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5871 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5872 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005873 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005874 "vkCreateImageView(): If image was created with usage containing "
5875 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5876 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5877 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5878 }
5879 }
5880 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005881
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005882 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5883 if (pCreateInfo->subresourceRange.levelCount != 1) {
5884 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5885 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5886 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5887 pCreateInfo->subresourceRange.levelCount);
5888 }
5889 if (pCreateInfo->subresourceRange.layerCount != 1) {
5890 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5891 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5892 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5893 pCreateInfo->subresourceRange.layerCount);
5894 }
5895 }
5896
Nathaniel Cesario42d5b282021-08-17 12:47:24 -06005897 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(view_format) &&
ziga-lunargc290c7f2021-07-31 22:01:46 +02005898 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5899 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5900 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5901 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5902 string_VkFormat(image_format));
5903 }
5904
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005905 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5906 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5907 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5908 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5909 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5910 }
5911 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5912 skip |=
5913 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5914 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5915 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5916 }
5917 }
sfricke-samsung45996a42021-09-16 13:45:27 -07005918 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005919 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005920 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005921 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5922 "vkCreateImageView(): If image was created with flags containing "
5923 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5924 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005925 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005926 }
5927 }
5928
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005929 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07005930 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005931 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5932 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5933 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5934 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5935 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5936 }
5937 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005938
sfricke-samsung45996a42021-09-16 13:45:27 -07005939 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005940 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005941 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5942 // VK_COMPONENT_SWIZZLE_IDENTITY."
5943 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5944 // also be defined via R, G, B, A enums in the correct order.
5945 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005946 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005947 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005948 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5949 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5950 }
5951
5952 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5953 // disabled
5954 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5955 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5956 // spec. See Github issue #2361.
5957 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5958 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5959 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07005960 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005961 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5962 "vkCreateImageView (portability error): ImageView format must have"
5963 " the same number of components and bits per component as the Image's format");
5964 }
5965 }
Tony-LunarG69604c42021-11-22 16:00:12 -07005966
5967 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
5968 if (image_view_min_lod) {
5969 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
5970 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
5971 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
5972 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
5973 image_view_min_lod->minLod);
5974 }
5975 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
5976 if (image_view_min_lod->minLod > max_level) {
5977 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
5978 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
5979 "accessible to the view (%" PRIu32 ")",
5980 image_view_min_lod->minLod, max_level);
5981 }
5982 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005983 }
5984 return skip;
5985}
5986
Jeff Leger178b1e52020-10-05 12:22:23 -04005987template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005988bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005989 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005990 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005991 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5992 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5993 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005994
5995 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5996 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5997 VkDeviceSize src_min = UINT64_MAX;
5998 VkDeviceSize src_max = 0;
5999 VkDeviceSize dst_min = UINT64_MAX;
6000 VkDeviceSize dst_max = 0;
6001
6002 for (uint32_t i = 0; i < regionCount; i++) {
6003 src_min = std::min(src_min, pRegions[i].srcOffset);
6004 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
6005 dst_min = std::min(dst_min, pRegions[i].dstOffset);
6006 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
6007
6008 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
6009 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006010 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006011 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006012 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6013 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
6014 func_name, i, pRegions[i].srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006015 }
6016
6017 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
6018 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006019 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006020 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006021 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6022 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
6023 func_name, i, pRegions[i].dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006024 }
6025
6026 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6027 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006028 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006029 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006030 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006031 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006032 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006033 }
6034
6035 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6036 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006037 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006038 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006039 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006040 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006041 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006042 }
6043 }
6044
6045 // 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 -06006046 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006047 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006048 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006049 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04006050 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006051 }
6052 }
6053
6054 return skip;
6055}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006056template <typename RegionType>
6057bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
6058 const RegionType *pRegions, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006059 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6060 const auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6061 const auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006062
sfricke-samsung11813ab2021-10-20 14:53:37 -07006063 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6064 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFER2KHR : CMD_COPYBUFFER;
6065 const char *func_name = CommandTypeString(cmd_type);
6066 const char *vuid;
6067
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006068 bool skip = false;
sfricke-samsung11813ab2021-10-20 14:53:37 -07006069 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006070 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006071 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006072 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006073
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006074 // Validate that SRC & DST buffers have correct usage flags set
sfricke-samsung11813ab2021-10-20 14:53:37 -07006075 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006076 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006077 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6078 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006079 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006080 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6081
Jeremy Gebben9f537102021-10-05 16:37:12 -06006082 skip |= ValidateCmd(cb_node.get(), cmd_type);
6083 skip |= ValidateCmdCopyBufferBounds(src_buffer_state.get(), dst_buffer_state.get(), regionCount, pRegions, version);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006084
6085 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006086 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006087 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006088 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006089 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006090 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006091 return skip;
6092}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006093
sfricke-samsung11813ab2021-10-20 14:53:37 -07006094bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6095 uint32_t regionCount, const VkBufferCopy *pRegions) const {
6096 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, COPY_COMMAND_VERSION_1);
6097}
6098
Jeff Leger178b1e52020-10-05 12:22:23 -04006099bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6100 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006101 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6102 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006103}
6104
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006105bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006106 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006107 auto buffer_state = Get<BUFFER_STATE>(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006108 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006109 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006110 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6111 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006112 }
6113 }
6114 return skip;
6115}
6116
Jeff Bolz5c801d12019-10-09 10:38:45 -05006117bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6118 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006119 const auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006120
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006121 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006122 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006123 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006124 }
6125 return skip;
6126}
6127
Jeff Bolz5c801d12019-10-09 10:38:45 -05006128bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006129 return ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006130}
6131
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006132void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6133 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6134 if (buffer_state) {
6135 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
6136 if (itr != buffer_address_map_.end()) {
6137 buffer_address_map_.erase(itr);
6138 }
6139 }
6140 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6141}
6142
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006143bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006144 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006145 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006146 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006147 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006148 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006149 }
6150 return skip;
6151}
6152
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006153bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006154 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006155 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6156 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006157 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006158 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6159 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006160 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006161 skip |=
6162 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6163 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006164
Jeremy Gebben9f537102021-10-05 16:37:12 -06006165 skip |=
6166 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6167 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6168 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006169
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006170 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006171 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6172 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6173 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6174 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006175 }
6176
6177 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006178 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6179 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6180 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6181 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006182 }
6183
sfricke-samsung45996a42021-09-16 13:45:27 -07006184 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006185 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006186 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6187 }
6188
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006189 return skip;
6190}
6191
Jeff Leger178b1e52020-10-05 12:22:23 -04006192template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006193bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006194 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006195 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006196 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006197 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6198 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006199
sfricke-samsung125d2b42020-05-28 06:32:43 -07006200 assert(image_state != nullptr);
6201 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006202
6203 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006204 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006205 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6206 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006207 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006208 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6209 "and 1, respectively.",
6210 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006211 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006212 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006213
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006214 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6215 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006216 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006217 "%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 -07006218 "must be 0 and 1, respectively.",
6219 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006220 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006221 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006222
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006223 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6224 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006225 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006226 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006227 "For 3D images these must be 0 and 1, respectively.",
6228 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006229 }
6230 }
6231
6232 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006233 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006234 const uint32_t element_size =
6235 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006236 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006237
sfricke-samsung8feecc12021-01-23 03:28:38 -08006238 if (FormatIsDepthOrStencil(image_format)) {
6239 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006240 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006241 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6242 " must be a multiple 4 if using a depth/stencil format (%s).",
6243 function, i, bufferOffset, string_VkFormat(image_format));
6244 }
6245 } else {
6246 // If not depth/stencil and not multi-plane
6247 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006248 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
sfricke-samsung8feecc12021-01-23 03:28:38 -08006249 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6250 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006251 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006252 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6253 " must be a multiple of this format's texel size (%" PRIu32 ").",
6254 function, i, bufferOffset, element_size);
6255 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006256 }
6257
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006258 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6259 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006260 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006261 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006262 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006263 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006264 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006265 }
6266
6267 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6268 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006269 vuid =
6270 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006271 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006272 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006273 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6274 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006275 }
6276
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006277 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006278 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006279 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006280 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 -06006281 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6282 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006283 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006284 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006285 "zero or <= image subresource width (%d).",
6286 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006287 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006288 }
6289
6290 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006291 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 -06006292 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6293 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006294 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006295 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006296 "zero or <= image subresource height (%d).",
6297 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006298 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006299 }
6300
6301 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006302 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 -06006303 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6304 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006305 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006306 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006307 "zero or <= image subresource depth (%d).",
6308 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006309 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006310 }
6311
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006312 // subresource aspectMask must have exactly 1 bit set
6313 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006314 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006315 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006316 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006317 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006318 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006319 }
6320
6321 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006322 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006323 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006324 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006325 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6326 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006327 }
6328
6329 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006330 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006331 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006332
6333 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006334 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006335 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
6336 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
6337 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006338 }
6339
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006340 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006341 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006342 skip |=
6343 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
6344 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
6345 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006346 }
6347
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006348 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006349 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6350 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6351 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006352 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006353 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006354 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006355 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6356 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006357 }
6358
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006359 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006360 if (SafeModulo(bufferOffset, element_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006361 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006362 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006363 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006364 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006365 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006366
6367 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006368 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006369 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006370 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006371 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006372 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006373 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006374 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6375 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006376 }
6377
6378 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006379 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006380 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006381 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006382 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006383 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006384 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6385 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006386 }
6387
6388 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006389 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006390 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006391 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006392 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006393 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006394 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6395 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006396 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006397 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006398
6399 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006400 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006401 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006402 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006403 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006404 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006405 "format has three planes.",
6406 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006407 }
6408
6409 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006410 if (0 ==
6411 (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 -06006412 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006413 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006414 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6415 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006416 } else {
6417 // Know aspect mask is valid
6418 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6419 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006420 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006421 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006422 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006423 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006424 " 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 -08006425 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006426 string_VkFormat(compatible_format));
6427 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006428 }
6429 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006430
6431 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006432 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006433 assert(command_pool != nullptr);
6434 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006435 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006436 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006437 LogObjectList objlist(cb_node->commandBuffer());
6438 objlist.add(command_pool->commandPool());
6439 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006440 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6441 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6442 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6443 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006444 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6445 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006446 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006447 }
6448
6449 return skip;
6450}
6451
Jeff Leger178b1e52020-10-05 12:22:23 -04006452template <typename BufferImageCopyRegionType>
6453bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6454 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006455 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006456 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006457
6458 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006459 VkExtent3D extent = pRegions[i].imageExtent;
6460 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006461
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006462 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6463 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006464 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006465 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6466 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006467 }
6468
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006469 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006470
sfricke-samsung01da6312021-10-20 07:51:32 -07006471 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6472 // vkspec.html#_common_operation)
6473 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006474 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006475 if (image_extent.width % block_extent.width) {
6476 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6477 }
6478 if (image_extent.height % block_extent.height) {
6479 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6480 }
6481 if (image_extent.depth % block_extent.depth) {
6482 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6483 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006484 }
6485
Dave Houltonfc1a4052017-04-27 14:32:45 -06006486 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006487 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006488 }
6489 }
6490
6491 return skip;
6492}
6493
Jeff Leger178b1e52020-10-05 12:22:23 -04006494template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006495bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006496 const BufferImageCopyRegionType *pRegions, const char *func_name,
6497 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006498 bool skip = false;
6499
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006500 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006501
6502 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006503 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format);
6504 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6505 if (buffer_copy_size != 0) {
6506 const VkDeviceSize max_buffer_copy = buffer_copy_size + pRegions[i].bufferOffset;
6507 if (buffer_size < max_buffer_copy) {
6508 skip |= LogError(device, msg_code,
6509 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6510 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
6511 func_name, i, buffer_copy_size, pRegions[i].bufferOffset,
6512 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6513 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006514 }
6515 }
6516
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006517 return skip;
6518}
6519
Jeff Leger178b1e52020-10-05 12:22:23 -04006520template <typename BufferImageCopyRegionType>
6521bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6522 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6523 CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006524 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6525 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
6526 const auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006527
Jeff Leger178b1e52020-10-05 12:22:23 -04006528 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006529 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
sfricke-samsung85584a72021-09-30 21:43:38 -07006530 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006531 const char *vuid;
6532
Jeremy Gebben9f537102021-10-05 16:37:12 -06006533 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006534
6535 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006536 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006537
6538 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006539 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006540
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006541 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006542
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006543 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006544 vuid =
6545 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6546 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6547 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6548 "or transfer capabilities.",
6549 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006550 }
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006551 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006552 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006553 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006554 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006555
Jeff Leger178b1e52020-10-05 12:22:23 -04006556 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6557 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006558 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006559
6560 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006561 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006562 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006563 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006564
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006565 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006566 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006567 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006568 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006569 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006570 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006571 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006572 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006573 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006574 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006575 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006576 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006577 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006578
6579 // Validation for VK_EXT_fragment_density_map
6580 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006581 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006582 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006583 "%s: srcImage must not have been created with flags containing "
6584 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6585 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006586 }
6587
sfricke-samsung45996a42021-09-16 13:45:27 -07006588 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006589 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006590 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006591 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006592 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006593
sfricke-samsung45996a42021-09-16 13:45:27 -07006594 const char *src_invalid_layout_vuid =
6595 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6596 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6597 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6598 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6599 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006600
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006601 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006602 skip |= ValidateImageSubresourceLayers(cb_node.get(), &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04006603 vuid =
6604 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006605 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006606 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6607 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006608 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &pRegions[i], i,
6609 func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006610 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6611 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006612 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), pRegions[i].imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006613 "imageSubresource", vuid);
6614 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6615 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006616 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006617 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006618 }
6619 return skip;
6620}
6621
Jeff Leger178b1e52020-10-05 12:22:23 -04006622bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6623 VkBuffer dstBuffer, uint32_t regionCount,
6624 const VkBufferImageCopy *pRegions) const {
6625 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6626 COPY_COMMAND_VERSION_1);
6627}
6628
6629bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6630 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6631 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6632 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6633 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6634}
6635
John Zulauf1686f232019-07-09 16:27:11 -06006636void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6637 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6638 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6639
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006640 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6641 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006642 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006643 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006644 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006645 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006646}
6647
Jeff Leger178b1e52020-10-05 12:22:23 -04006648void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6649 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6650 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6651
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006652 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6653 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006654 // Make sure that all image slices record referenced layout
6655 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006656 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6657 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006658 }
6659}
6660
6661template <typename RegionType>
6662bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6663 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6664 CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006665 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6666 const auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6667 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006668
Jeff Leger178b1e52020-10-05 12:22:23 -04006669 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006670 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07006671 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006672 const char *vuid;
6673
Jeremy Gebben9f537102021-10-05 16:37:12 -06006674 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006675
6676 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006677 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006678
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006679 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006680 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006681 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006682 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006683
6684 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6685 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006686 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006687 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006688 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006689 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006690 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006691 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006692 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006693 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006694 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006695 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006696 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006697 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006698 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006699 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006700 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006701 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006702 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006703
6704 // Validation for VK_EXT_fragment_density_map
6705 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006706 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006707 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006708 "%s: dstImage must not have been created with flags containing "
6709 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6710 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006711 }
6712
sfricke-samsung45996a42021-09-16 13:45:27 -07006713 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006714 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006715 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006716 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006717 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006718
sfricke-samsung45996a42021-09-16 13:45:27 -07006719 const char *dst_invalid_layout_vuid =
6720 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6721 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6722 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6723 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6724 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006725
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006726 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006727 skip |= ValidateImageSubresourceLayers(cb_node.get(), &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
Jeff Leger178b1e52020-10-05 12:22:23 -04006728 vuid =
6729 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006730 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006731 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6732 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006733 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &pRegions[i], i,
6734 func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006735 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6736 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006737 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), pRegions[i].imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006738 "imageSubresource", vuid);
6739 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6740 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006741 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006742 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006743
6744 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006745 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07006746 assert(command_pool != nullptr);
6747 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006748 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsungea4fd142020-10-17 23:51:59 -07006749 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6750 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6751 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006752 LogObjectList objlist(cb_node->commandBuffer());
6753 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006754 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6755 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006756 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006757 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6758 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6759 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006760 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6761 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006762 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006763 }
6764 return skip;
6765}
6766
Jeff Leger178b1e52020-10-05 12:22:23 -04006767bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6768 VkImageLayout dstImageLayout, uint32_t regionCount,
6769 const VkBufferImageCopy *pRegions) const {
6770 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6771 COPY_COMMAND_VERSION_1);
6772}
6773
6774bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6775 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6776 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6777 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6778 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6779}
6780
John Zulauf1686f232019-07-09 16:27:11 -06006781void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6782 VkImageLayout dstImageLayout, uint32_t regionCount,
6783 const VkBufferImageCopy *pRegions) {
6784 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6785
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006786 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6787 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006788 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006789 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006790 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006791 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006792}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006793
Jeff Leger178b1e52020-10-05 12:22:23 -04006794void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6795 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6796 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6797
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006798 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6799 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006800 // Make sure that all image slices are record referenced layout
6801 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006802 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6803 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006804 }
6805}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006806bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006807 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006808 bool skip = false;
6809 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6810
Dave Houlton1d960ff2018-01-19 12:17:05 -07006811 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006812 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6813 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6814 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006815 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6816 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006817 }
6818
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006819 const auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006820 if (!image_entry) {
6821 return skip;
6822 }
6823
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006824 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07006825 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006826 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6827 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006828 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6829 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6830 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006831 }
6832 } else {
6833 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006834 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6835 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006836 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006837 }
6838
Dave Houlton1d960ff2018-01-19 12:17:05 -07006839 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006840 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006841 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6842 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6843 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006844 }
6845
Dave Houlton1d960ff2018-01-19 12:17:05 -07006846 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006847 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006848 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6849 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6850 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006851 }
6852
Dave Houlton1d960ff2018-01-19 12:17:05 -07006853 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006854 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006855 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6856 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006857 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006858 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6859 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006860 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006861 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6862 }
6863 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006864 skip |= LogError(image, vuid,
6865 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6866 ") must be a single-plane specifier flag.",
6867 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006868 }
6869 } else if (FormatIsColor(img_format)) {
6870 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02006871 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006872 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6873 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006874 }
6875 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006876 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006877 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006878 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02006879 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
6880 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
6881 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6882 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
6883 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
6884 string_VkFormat(img_format));
6885 }
6886 } else {
6887 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
6888 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
6889 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
6890 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
6891 string_VkFormat(img_format));
6892 }
6893 }
6894 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
6895 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
6896 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6897 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
6898 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
6899 string_VkFormat(img_format));
6900 }
6901 } else {
6902 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
6903 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
6904 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
6905 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
6906 string_VkFormat(img_format));
6907 }
6908 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006909 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6910 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6911 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6912 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006913 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6914 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6915 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006916 }
6917 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006918
sfricke-samsung45996a42021-09-16 13:45:27 -07006919 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006920 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006921 }
6922
Mike Weiblen672b58b2017-02-21 14:32:53 -07006923 return skip;
6924}
sfricke-samsung022fa252020-07-24 03:26:16 -07006925
6926// Validates the image is allowed to be protected
6927bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006928 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006929 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006930
6931 // if driver supports protectedNoFault the operation is valid, just has undefined values
6932 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006933 LogObjectList objlist(cb_state->commandBuffer());
6934 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006935 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 -06006936 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6937 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006938 }
6939 return skip;
6940}
6941
6942// Validates the image is allowed to be unprotected
6943bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006944 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006945 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006946
6947 // if driver supports protectedNoFault the operation is valid, just has undefined values
6948 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006949 LogObjectList objlist(cb_state->commandBuffer());
6950 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006951 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 -06006952 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6953 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006954 }
6955 return skip;
6956}
6957
6958// Validates the buffer is allowed to be protected
6959bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006960 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006961 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006962
6963 // if driver supports protectedNoFault the operation is valid, just has undefined values
6964 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006965 LogObjectList objlist(cb_state->commandBuffer());
6966 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006967 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 -06006968 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6969 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006970 }
6971 return skip;
6972}
6973
6974// Validates the buffer is allowed to be unprotected
6975bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006976 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006977 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006978
6979 // if driver supports protectedNoFault the operation is valid, just has undefined values
6980 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006981 LogObjectList objlist(cb_state->commandBuffer());
6982 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006983 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 -06006984 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6985 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006986 }
6987 return skip;
6988}