blob: fba56259f9533776ebc35bae5173131a91d17177 [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 Gebben6335df62021-11-01 10:50:13 -0600874 auto &write_subresource_map = layout_updates[image_state];
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 Gebben6335df62021-11-01 10:50:13 -0600880 const auto &current_subresource_map = current_map.find(image_state);
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
John Zulaufa4472282019-08-22 14:44:34 -06001002const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001003 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001004}
1005
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001006const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001007 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001008}
1009
John Zulaufa4472282019-08-22 14:44:34 -06001010VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1011 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1012}
1013
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001014VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1015 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1016}
1017
John Zulaufa4472282019-08-22 14:44:34 -06001018const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001019 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001020}
1021
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001022const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001023 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001024}
John Zulaufa4472282019-08-22 14:44:34 -06001025
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001026template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001027void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001028 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001029 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001030 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001031 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001032 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001033 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001034 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001035 }
John Zulaufa4472282019-08-22 14:44:34 -06001036
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001037 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1038 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001039 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1040 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001041 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1042
1043 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001044 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1045 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1046 auto handle_state = BarrierHandleState(*this, barrier);
1047 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1048 if (!mode_concurrent) {
1049 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001050 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001051 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001052 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1053 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001054 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001055 src_queue_family, dst_queue_family);
1056 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001057 }
1058 }
1059}
1060
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001061// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001062template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001063bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001064 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1065 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001066 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1067 using sync_vuid_maps::GetImageBarrierVUID;
1068 using sync_vuid_maps::ImageError;
1069
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001070 bool skip = false;
1071 const auto *fb_state = framebuffer;
1072 assert(fb_state);
1073 const auto img_bar_image = img_barrier.image;
1074 bool image_match = false;
1075 bool sub_image_found = false; // Do we find a corresponding subpass description
1076 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1077 uint32_t attach_index = 0;
1078 // Verify that a framebuffer image matches barrier image
1079 const auto attachment_count = fb_state->createInfo.attachmentCount;
1080 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001081 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001082 if (view_state && (img_bar_image == view_state->create_info.image)) {
1083 image_match = true;
1084 attach_index = attachment;
1085 break;
1086 }
1087 }
1088 if (image_match) { // Make sure subpass is referring to matching attachment
1089 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1090 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1091 sub_image_found = true;
1092 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001093 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001094 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1095 if (resolve && resolve->pDepthStencilResolveAttachment &&
1096 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1097 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1098 sub_image_found = true;
1099 }
1100 }
1101 if (!sub_image_found) {
1102 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1103 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1104 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1105 sub_image_found = true;
1106 break;
1107 }
1108 if (!sub_image_found && sub_desc.pResolveAttachments &&
1109 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1110 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1111 sub_image_found = true;
1112 break;
1113 }
1114 }
1115 }
1116 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001117 auto img_loc = loc.dot(Field::image);
1118 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1119 skip |=
1120 LogError(rp_handle, vuid,
1121 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1122 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1123 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001124 }
1125 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001126 auto img_loc = loc.dot(Field::image);
1127 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001128 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 -07001129 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001130 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001131 }
1132 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001133 auto layout_loc = loc.dot(Field::oldLayout);
1134 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001135 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001136 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001137 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001138 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001139 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1140 } else {
1141 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1142 LogObjectList objlist(rp_handle);
1143 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001144 auto layout_loc = loc.dot(Field::oldLayout);
1145 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1146 skip |= LogError(objlist, vuid,
1147 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001148 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001149 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001150 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1151 string_VkImageLayout(img_barrier.oldLayout));
1152 }
1153 }
1154 return skip;
1155}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001156// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001157template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001158 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1159 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1160 const VkImageMemoryBarrier &img_barrier,
1161 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001162template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001163 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1164 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1165 const VkImageMemoryBarrier2KHR &img_barrier,
1166 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001167
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001168template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001169void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001170 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001171 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1172 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1173 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1174 const auto active_subpass = cb_state->activeSubpass;
1175 const auto rp_state = cb_state->activeRenderPass;
1176 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001177 // Secondary CB case w/o FB specified delay validation
1178 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001179 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001180 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001181 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001182 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1183 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1184 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001185 render_pass, barrier, primary_cb);
1186 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001187 }
1188}
1189
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001190void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001191 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1192 const VkImageMemoryBarrier *pImageMemBarriers) {
1193 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001194 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001195 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1196 }
1197 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001198 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001199 const auto &img_barrier = pImageMemBarriers[i];
1200 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1201 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1202 }
1203}
1204
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001205void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001206 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001207 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001208 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1209 }
1210 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001211 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1213 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1214 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1215 }
1216}
1217
1218template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001219bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001220 const char *operation, const TransferBarrier &barrier,
1221 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001222 // Record to the scoreboard or report that we have a duplication
1223 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001224 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001225 if (!inserted.second && inserted.first->second != cb_state) {
1226 // 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 -06001227 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001228 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001229 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001230 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001231 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1232 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001233 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001234 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001235 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001236 }
1237 return skip;
1238}
1239
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001240template <typename TransferBarrier>
1241bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1242 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1243 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001244 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001245 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001246 const char *barrier_name = TransferBarrier::BarrierName();
1247 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001248 // No release should have an extant duplicate (WARNING)
1249 for (const auto &release : cb_barriers.release) {
1250 // Check the global pending release barriers
1251 const auto set_it = global_release_barriers.find(release.handle);
1252 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001253 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001254 const auto found = set_for_handle.find(release);
1255 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001256 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001257 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1258 " to dstQueueFamilyIndex %" PRIu32
1259 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1260 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1261 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001262 }
1263 }
1264 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1265 }
1266 // Each acquire must have a matching release (ERROR)
1267 for (const auto &acquire : cb_barriers.acquire) {
1268 const auto set_it = global_release_barriers.find(acquire.handle);
1269 bool matching_release_found = false;
1270 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001271 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001272 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1273 }
1274 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001275 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001276 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1277 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1278 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1279 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001280 }
1281 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1282 }
1283 return skip;
1284}
1285
John Zulauf3b04ebd2019-07-18 14:08:11 -06001286bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001287 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1288 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001289 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001290 skip |=
1291 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1292 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1293 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001294 return skip;
1295}
1296
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001297template <typename TransferBarrier>
1298void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1299 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001300 // Add release barriers from this submit to the global map
1301 for (const auto &release : cb_barriers.release) {
1302 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1303 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1304 global_release_barriers[release.handle].insert(release);
1305 }
1306
1307 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1308 for (const auto &acquire : cb_barriers.acquire) {
1309 // NOTE: We're not using [] because we don't want to create entries for missing releases
1310 auto set_it = global_release_barriers.find(acquire.handle);
1311 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001312 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001313 set_for_handle.erase(acquire);
1314 if (set_for_handle.size() == 0) { // Clean up empty sets
1315 global_release_barriers.erase(set_it);
1316 }
1317 }
1318 }
1319}
1320
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001321void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001322 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1323 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1324 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001325}
1326
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001327template <typename ImgBarrier>
1328void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1329 // For ownership transfers, the barrier is specified twice; as a release
1330 // operation on the yielding queue family, and as an acquire operation
1331 // on the acquiring queue family. This barrier may also include a layout
1332 // transition, which occurs 'between' the two operations. For validation
1333 // purposes it doesn't seem important which side performs the layout
1334 // transition, but it must not be performed twice. We'll arbitrarily
1335 // choose to perform it as part of the acquire operation.
1336 //
1337 // However, we still need to record initial layout for the "initial layout" validation
1338 for (uint32_t i = 0; i < barrier_count; i++) {
1339 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001340 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001341 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001342 if (image_state) {
1343 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1344 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001345 }
1346}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001347// explictly instantiate this template so it can be used in core_validation.cpp
1348template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1349 const VkImageMemoryBarrier *barrier);
1350template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1351 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001352
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001353VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1354
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001355template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001356void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001357 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001358 if (enabled_features.synchronization2_features.synchronization2) {
1359 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1360 return;
1361 }
1362 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001363 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001364
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001365 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1366 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001367
1368 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001369 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001370 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1371 }
1372
John Zulauf2be3fe02019-12-30 09:48:02 -07001373 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001374 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001375 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001376 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001377 }
unknown86bcb3a2019-07-11 13:05:36 -06001378}
1379
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001380bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1381 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1382 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1383 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001384 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001385 assert(cb_node);
1386 assert(image_state);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001387 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001388
Jeremy Gebben6335df62021-11-01 10:50:13 -06001389 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06001390 if (subresource_map) {
1391 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001392 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001393 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1394 // the next "constant value" range
1395 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001396 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001397 *error = true;
Jeremy Gebben6335df62021-11-01 10:50:13 -06001398 subres_skip |=
1399 LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
1400 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1401 "%s layout %s.",
1402 caller, report_data->FormatHandle(image_state->Handle()).c_str(), pos->subresource.arrayLayer,
1403 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1404 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001405 }
John Zulauf5e617452019-11-19 14:44:16 -07001406 }
John Zulauff660ad62019-03-23 07:16:05 -06001407 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001408 }
John Zulauff660ad62019-03-23 07:16:05 -06001409
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001410 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1411 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1412 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001413 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1414 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001415 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001416 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001417 report_data->FormatHandle(image_state->Handle()).c_str(),
1418 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001419 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001420 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001421 if (image_state->shared_presentable) {
1422 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001423 skip |=
1424 LogError(device, layout_invalid_msg_code,
1425 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1426 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001427 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001428 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001429 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001430 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001431 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001432 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001433 report_data->FormatHandle(image_state->Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001434 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001435 }
1436 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001437 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001438}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001439bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001440 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1441 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001442 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001443 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1444 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1445}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001446
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001447void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001448 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001449 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001450 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001451
Mike Schuchardt2df08912020-12-15 16:28:09 -08001452 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001453 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001454 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001455 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001456 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001457 VkImageLayout stencil_layout = kInvalidLayout;
1458 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001459 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001460 if (attachment_description_stencil_layout) {
1461 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1462 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001463 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001464 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001465 }
1466 }
1467}
Dave Houltone19e20d2018-02-02 16:32:41 -07001468
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001469#ifdef VK_USE_PLATFORM_ANDROID_KHR
1470// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1471// This could also move into a seperate core_validation_android.cpp file... ?
1472
1473//
1474// AHB-specific validation within non-AHB APIs
1475//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001476bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001477 bool skip = false;
1478
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001479 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001480 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001481 if (0 != ext_fmt_android->externalFormat) {
1482 if (VK_FORMAT_UNDEFINED != create_info->format) {
1483 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001484 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1485 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1486 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001487 }
1488
1489 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001490 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1491 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1492 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001493 }
1494
1495 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001496 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1497 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001498 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001499 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001500 }
1501
1502 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001503 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1504 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1505 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001506 }
1507 }
1508
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001509 if ((0 != ext_fmt_android->externalFormat) &&
1510 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001511 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001512 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1513 ") which has "
1514 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1515 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001516 }
1517 }
1518
Dave Houltond9611312018-11-19 17:03:36 -07001519 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001520 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001521 skip |=
1522 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1523 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1524 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001525 }
1526 }
1527
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001528 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001529 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1530 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001531 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001532 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1533 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1534 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1535 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001536 }
1537
1538 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001539 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1540 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1541 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1542 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1543 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001544 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001545 }
1546
1547 return skip;
1548}
1549
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001550bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001551 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001552 const auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001553
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001554 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001555 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001556 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1557 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001558 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001559 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001560 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001561
Dave Houltond9611312018-11-19 17:03:36 -07001562 // Chain must include a compatible ycbcr conversion
1563 bool conv_found = false;
1564 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001565 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001566 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001567 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001568 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001569 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001570 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001571 }
Dave Houltond9611312018-11-19 17:03:36 -07001572 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001573 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001574 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001575 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1576 "an externalFormat (%" PRIu64
1577 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1578 "with the same external format.",
1579 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001580 }
1581
1582 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001583 if (IsIdentitySwizzle(create_info->components) == false) {
1584 skip |= LogError(
1585 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1586 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1587 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1588 "= %s.",
1589 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1590 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001591 }
1592 }
Dave Houltond9611312018-11-19 17:03:36 -07001593
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001594 return skip;
1595}
1596
John Zulaufa26d3c82019-08-14 16:09:08 -06001597bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001598 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001599
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001600 const auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001601 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001602 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001603 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1604 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1605 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1606 "bound to memory.");
1607 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001608 }
1609 return skip;
1610}
1611
1612#else
1613
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001614bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001615 return false;
1616}
1617
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001618bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001619
John Zulaufa26d3c82019-08-14 16:09:08 -06001620bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001621
1622#endif // VK_USE_PLATFORM_ANDROID_KHR
1623
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001624bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1625 bool skip = false;
1626
1627 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1628 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1629 const VkImageTiling image_tiling = pCreateInfo->tiling;
1630 const VkFormat image_format = pCreateInfo->format;
1631
1632 if (image_format == VK_FORMAT_UNDEFINED) {
1633 // VU 01975 states format can't be undefined unless an android externalFormat
1634#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001635 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001636 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1637 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1638 if (it != ahb_ext_formats_map.end()) {
1639 tiling_features = it->second;
1640 }
1641 }
1642#endif
1643 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1644 uint64_t drm_format_modifier = 0;
1645 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001646 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001647 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001648 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001649
1650 if (drm_explicit != nullptr) {
1651 drm_format_modifier = drm_explicit->drmFormatModifier;
1652 } else {
1653 // VUID 02261 makes sure its only explict or implict in parameter checking
1654 assert(drm_implicit != nullptr);
1655 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1656 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1657 }
1658 }
1659
1660 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1661 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1662 nullptr};
1663 format_properties_2.pNext = (void *)&drm_properties_list;
1664 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001665 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1666 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1667 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1668 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001669
1670 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1671 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1672 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1673 }
1674 }
1675 } else {
1676 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1677 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1678 : format_properties.optimalTilingFeatures;
1679 }
1680
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001681 // Lack of disjoint format feature support while using the flag
1682 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1683 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1684 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1685 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1686 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1687 string_VkFormat(pCreateInfo->format));
1688 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001689
1690 return skip;
1691}
1692
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001693bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001694 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001695 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001696
sfricke-samsung45996a42021-09-16 13:45:27 -07001697 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001698 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001699 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1700 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001701 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1702 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001703 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001704 }
1705
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001706 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1707 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001708 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1709 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1710 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001711 }
Dave Houlton130c0212018-01-29 13:39:56 -07001712 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001713
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001714 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001715 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1716 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1717 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001718 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001719 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1720 "device maxFramebufferWidth (%u).",
1721 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001722 }
1723
1724 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001725 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001726 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1727 "device maxFramebufferHeight (%u).",
1728 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001729 }
1730
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001731 VkImageCreateFlags sparseFlags =
1732 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1733 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1734 skip |= LogError(
1735 device, "VUID-VkImageCreateInfo-None-01925",
1736 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1737 }
1738
sfricke-samsung45996a42021-09-16 13:45:27 -07001739 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map) ||
1740 IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001741 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1742 static_cast<float>(device_limits->maxFramebufferWidth) /
1743 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001744 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1745 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001746 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1747 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1748 "ceiling of device "
1749 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1750 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1751 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001752 }
1753
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001754 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1755 static_cast<float>(device_limits->maxFramebufferHeight) /
1756 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001757 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1758 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001759 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1760 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1761 "ceiling of device "
1762 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1763 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1764 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001765 }
1766 }
1767
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001768 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001769 VkResult result = VK_SUCCESS;
1770 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1771 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1772 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1773 &format_limits);
1774 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001775 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1776 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001777 if (modifier_list) {
1778 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001779 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001780 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001781 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001782 image_format_info.type = pCreateInfo->imageType;
1783 image_format_info.format = pCreateInfo->format;
1784 image_format_info.tiling = pCreateInfo->tiling;
1785 image_format_info.usage = pCreateInfo->usage;
1786 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001787 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001788
1789 result =
1790 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1791 format_limits = image_format_properties.imageFormatProperties;
1792
1793 /* The application gives a list of modifier and the driver
1794 * selects one. If one is wrong, stop there.
1795 */
1796 if (result != VK_SUCCESS) break;
1797 }
1798 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001799 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001800 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001801 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001802 image_format_info.type = pCreateInfo->imageType;
1803 image_format_info.format = pCreateInfo->format;
1804 image_format_info.tiling = pCreateInfo->tiling;
1805 image_format_info.usage = pCreateInfo->usage;
1806 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001807 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001808
1809 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1810 format_limits = image_format_properties.imageFormatProperties;
1811 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001812 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001813
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001814 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1815 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1816 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1817 if (result != VK_SUCCESS) {
1818 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001819#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001820 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001821#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001822 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001823 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001824 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1825 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001826#ifdef VK_USE_PLATFORM_ANDROID_KHR
1827 }
1828#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001829 } else {
1830 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1831 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001832 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1833 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1834 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001835 }
Dave Houlton130c0212018-01-29 13:39:56 -07001836
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001837 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1838 static_cast<uint64_t>(pCreateInfo->extent.height) *
1839 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1840 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001841
sfricke-samsung2e827212021-09-28 07:52:08 -07001842 // Depth/Stencil formats size can't be accurately calculated
1843 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1844 uint64_t total_size =
1845 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001846
sfricke-samsung2e827212021-09-28 07:52:08 -07001847 // Round up to imageGranularity boundary
1848 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1849 uint64_t ig_mask = image_granularity - 1;
1850 total_size = (total_size + ig_mask) & ~ig_mask;
1851
1852 if (total_size > format_limits.maxResourceSize) {
1853 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1854 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1855 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1856 total_size, format_limits.maxResourceSize);
1857 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001858 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001859
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001860 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001861 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1862 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1863 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001864 }
1865
1866 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001867 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1868 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1869 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001870 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001871
1872 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1873 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1874 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1875 pCreateInfo->extent.width, format_limits.maxExtent.width);
1876 }
1877
1878 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1879 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1880 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1881 pCreateInfo->extent.height, format_limits.maxExtent.height);
1882 }
1883
1884 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1885 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1886 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1887 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1888 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001889 }
1890
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001891 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001892 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001893 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001894 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001895 ? "VUID-VkImageCreateInfo-format-06414"
1896 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001897 skip |= LogError(device, error_vuid,
1898 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1899 "YCbCr Conversion format, arrayLayers must be 1",
1900 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001901 }
1902
1903 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001904 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001905 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1906 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001907 }
1908
1909 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001910 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001911 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001912 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1913 string_VkSampleCountFlagBits(pCreateInfo->samples));
1914 }
1915
1916 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001917 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001918 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001919 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1920 string_VkImageType(pCreateInfo->imageType));
1921 }
1922 }
1923
sfricke-samsung45996a42021-09-16 13:45:27 -07001924 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001925 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001926 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001927 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1928 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001929 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001930 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001931 }
1932 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001933 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1934 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1935 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001936 }
1937 }
1938 }
1939
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001940 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001941 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1942 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1943 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001944 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001945 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001946 }
1947
unknown2c877272019-07-11 12:56:50 -06001948 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1949 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1950 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001951 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1952 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1953 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001954 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001955
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001956 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001957 if (swapchain_create_info != nullptr) {
1958 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001959 const auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001960 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1961
1962 // Validate rest of Swapchain Image create check that require swapchain state
1963 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1964 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1965 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1966 skip |= LogError(
1967 device, vuid,
1968 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1969 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1970 }
1971 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1972 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1973 skip |= LogError(device, vuid,
1974 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1975 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1976 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08001977 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001978 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1979 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1980 skip |= LogError(device, vuid,
1981 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1982 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08001983 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001984 }
1985 }
1986 }
1987
sfricke-samsungedce77a2020-07-03 22:35:13 -07001988 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1989 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1990 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1991 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1992 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1993 }
1994 const VkImageCreateFlags invalid_flags =
1995 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1996 if ((pCreateInfo->flags & invalid_flags) != 0) {
1997 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1998 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1999 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2000 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2001 }
2002 }
2003
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002004 skip |= ValidateImageFormatFeatures(pCreateInfo);
2005
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002006 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002007 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002008 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2009 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2010 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2011 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2012 }
2013 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2014 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2015 skip |=
2016 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2017 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2018 }
2019 }
2020
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002021 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002022 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2023 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2024 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2025 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2026 "VkExternalMemoryImageCreateInfo chained structs.");
2027 }
2028 if (external_memory_create_info) {
2029 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2030 skip |= LogError(
2031 device, "VUID-VkImageCreateInfo-pNext-01443",
2032 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2033 " but pCreateInfo->initialLayout is %s.",
2034 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2035 }
2036 } else if (external_memory_create_info_nv) {
2037 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2038 skip |= LogError(
2039 device, "VUID-VkImageCreateInfo-pNext-01443",
2040 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2041 " but pCreateInfo->initialLayout is %s.",
2042 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002043 }
2044 }
2045
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002046 if (device_group_create_info.physicalDeviceCount == 1) {
2047 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2048 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2049 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2050 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2051 }
2052 }
2053
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002054 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002055}
2056
John Zulauf7eeb6f72019-06-17 11:56:36 -06002057void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2058 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2059 if (VK_SUCCESS != result) return;
2060
2061 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002062 auto image_state = Get<IMAGE_STATE>(*pImage);
2063 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002064}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002065
Jeff Bolz5c801d12019-10-09 10:38:45 -05002066bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002067 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002068 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002069 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002070 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002071 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002072 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2073 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002074 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002075 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002076 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002077 }
2078 return skip;
2079}
2080
John Zulauf7eeb6f72019-06-17 11:56:36 -06002081void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2082 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002083 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002084 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002085
Jeremy Gebben6335df62021-11-01 10:50:13 -06002086 imageLayoutMap.erase(image_state);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002087
2088 // Clean up generic image state
2089 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002090}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002091
sfricke-samsungcd924d92020-05-20 23:51:17 -07002092bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2093 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002094 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002095 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002096 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002097
2098 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002099 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2100 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002101 }
2102
sfricke-samsungcd924d92020-05-20 23:51:17 -07002103 if (FormatIsDepthOrStencil(format)) {
2104 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2105 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2106 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2107 } else if (FormatIsCompressed(format)) {
2108 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2109 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2110 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002111 }
2112
2113 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002114 skip |=
2115 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2116 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2117 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002118 }
2119 return skip;
2120}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002121
John Zulauf07288512019-07-05 11:09:50 -06002122bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2123 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2124 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002125 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002126 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2127 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002128 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002129 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2130 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002131 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002132
2133 } else {
2134 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002135 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002136 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002137 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002138 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2139 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002140 }
2141 } else {
2142 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2143 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002144 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002145 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002146 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2147 func_name, string_VkImageLayout(dest_image_layout));
2148 }
2149 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002150 }
2151
John Zulauff660ad62019-03-23 07:16:05 -06002152 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002153 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002154 if (subresource_map) {
2155 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002156 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002157 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002158 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2159 // the next "constant value" range
2160 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002161 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002162 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2163 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2164 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2165 } else {
2166 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002167 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002168 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002169 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2170 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2171 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002172 }
John Zulauf5e617452019-11-19 14:44:16 -07002173 }
John Zulauff660ad62019-03-23 07:16:05 -06002174 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002175 }
2176
2177 return skip;
2178}
2179
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002180bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2181 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002182 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002183 bool skip = false;
2184 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002185 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2186 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002187 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002188 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
sfricke-samsung85584a72021-09-30 21:43:38 -07002189 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002190 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002191 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2192 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002193 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002194 skip |=
2195 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2196 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2197 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002198 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002199 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002200 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002201 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002202 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002203 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002204 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002205 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002206 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2207 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2208 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2209 string_VkFormat(image_state->createInfo.format));
2210 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002211 }
2212 return skip;
2213}
2214
John Zulaufeabb4462019-07-05 14:13:03 -06002215void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2216 const VkClearColorValue *pColor, uint32_t rangeCount,
2217 const VkImageSubresourceRange *pRanges) {
2218 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2219
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002220 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2221 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002222 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002223 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002224 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002225 }
2226 }
2227}
2228
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002229bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2230 const char *apiName) const {
2231 bool skip = false;
2232
2233 // 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 -07002234 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002235 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2236 // Also VUID-VkClearDepthStencilValue-depth-00022
2237 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2238 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2239 "(=%f) is not within the [0.0, 1.0] range.",
2240 apiName, clearValue.depth);
2241 }
2242 }
2243
2244 return skip;
2245}
2246
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002247bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2248 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002249 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002250 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002251
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002252 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002253 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2254 const auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002255 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002256 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002257 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002258 "VUID-vkCmdClearDepthStencilImage-image-00010");
sfricke-samsung85584a72021-09-30 21:43:38 -07002259 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002260 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002261 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002262 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002263 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002264 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002265 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2266 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2267 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2268 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002269
2270 bool any_include_aspect_depth_bit = false;
2271 bool any_include_aspect_stencil_bit = false;
2272
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002273 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002274 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002275 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002276 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002277 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002278 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2279 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002280 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2281 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2282 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2283 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002284 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002285 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2286 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002287 if (FormatHasDepth(image_format) == false) {
2288 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2289 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2290 "doesn't have a depth component.",
2291 i, string_VkFormat(image_format));
2292 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002293 }
2294 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2295 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002296 if (FormatHasStencil(image_format) == false) {
2297 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2298 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2299 "%s doesn't have a stencil component.",
2300 i, string_VkFormat(image_format));
2301 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002302 }
2303 }
2304 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002305 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002306 if (image_stencil_struct != nullptr) {
2307 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2308 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002309 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2310 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2311 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2312 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002313 }
2314 } else {
2315 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002316 skip |= LogError(
2317 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002318 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2319 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2320 "in VkImageCreateInfo::usage used to create image");
2321 }
2322 }
2323 }
2324 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002325 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2326 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2327 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002328 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002329 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002330 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2331 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002332 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002333 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002334 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002335 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2336 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2337 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2338 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002339 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002340 }
2341 return skip;
2342}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002343
John Zulaufeabb4462019-07-05 14:13:03 -06002344void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2345 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2346 const VkImageSubresourceRange *pRanges) {
2347 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002348 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2349 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002350 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002351 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002352 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002353 }
2354 }
2355}
2356
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002357// Returns true if [x, xoffset] and [y, yoffset] overlap
2358static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2359 bool result = false;
2360 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2361 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2362
2363 if (intersection_max > intersection_min) {
2364 result = true;
2365 }
2366 return result;
2367}
2368
Jeff Leger178b1e52020-10-05 12:22:23 -04002369// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002370// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002371template <typename RegionType>
2372static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002373 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002374
Dave Houltonc991cc92018-03-06 11:08:51 -07002375 // Separate planes within a multiplane image cannot intersect
2376 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002377 return result;
2378 }
2379
Dave Houltonc991cc92018-03-06 11:08:51 -07002380 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2381 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2382 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002383 result = true;
2384 switch (type) {
2385 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002386 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002387 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002388 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002389 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002390 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002391 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002392 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002393 break;
2394 default:
2395 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2396 assert(false);
2397 }
2398 }
2399 return result;
2400}
2401
Dave Houltonfc1a4052017-04-27 14:32:45 -06002402// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002403static const uint32_t kXBit = 1;
2404static const uint32_t kYBit = 2;
2405static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002406static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002407 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002408 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002409 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2410 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002411 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002412 }
2413 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2414 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002415 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002416 }
2417 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2418 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002419 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002420 }
2421 return result;
2422}
2423
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002424// Test if two VkExtent3D structs are equivalent
2425static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2426 bool result = true;
2427 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2428 (extent->depth != other_extent->depth)) {
2429 result = false;
2430 }
2431 return result;
2432}
2433
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002434// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002435static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002436 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2437}
2438
2439// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002440VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002441 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2442 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002443 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002444 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002445 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002446 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002447 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002448 granularity.width *= block_size.width;
2449 granularity.height *= block_size.height;
2450 }
2451 }
2452 return granularity;
2453}
2454
2455// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2456static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2457 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002458 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2459 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002460 valid = false;
2461 }
2462 return valid;
2463}
2464
2465// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002466bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002467 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002468 bool skip = false;
2469 VkExtent3D offset_extent = {};
2470 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2471 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2472 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002473 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474 // 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 -07002475 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002476 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002477 "%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 "
2478 "image transfer granularity is (w=0, h=0, d=0).",
2479 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002480 }
2481 } else {
2482 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2483 // integer multiples of the image transfer granularity.
2484 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002485 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002486 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2487 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2488 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2489 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002490 }
2491 }
2492 return skip;
2493}
2494
2495// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002496bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002497 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002498 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002499 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002500 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002501 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2502 // subresource extent.
2503 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002504 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002505 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2506 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2507 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2508 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002509 }
2510 } else {
2511 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2512 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2513 // subresource extent dimensions.
2514 VkExtent3D offset_extent_sum = {};
2515 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2516 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2517 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002518 bool x_ok = true;
2519 bool y_ok = true;
2520 bool z_ok = true;
2521 switch (image_type) {
2522 case VK_IMAGE_TYPE_3D:
2523 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2524 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002525 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002526 case VK_IMAGE_TYPE_2D:
2527 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2528 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002529 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002530 case VK_IMAGE_TYPE_1D:
2531 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2532 (subresource_extent->width == offset_extent_sum.width));
2533 break;
2534 default:
2535 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2536 assert(false);
2537 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002538 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002539 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002540 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002541 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2542 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2543 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2544 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2545 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2546 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002547 }
2548 }
2549 return skip;
2550}
2551
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002552bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002553 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002554 bool skip = false;
2555 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002556 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2557 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002558 }
2559 return skip;
2560}
2561
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002562bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002563 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002564 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002565 bool skip = false;
2566 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2567 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002568 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002569 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2570 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002571 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002572 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002573 }
2574 return skip;
2575}
2576
Jeff Leger178b1e52020-10-05 12:22:23 -04002577// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2578template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002579bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002580 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002581 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002582 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002583 VkExtent3D granularity = GetScaledItg(cb_node, img);
2584 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002585 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002586 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002587 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002588 return skip;
2589}
2590
Jeff Leger178b1e52020-10-05 12:22:23 -04002591// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2592template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002593bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002594 const IMAGE_STATE *dst_img, const RegionType *region,
2595 const uint32_t i, const char *function,
2596 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002597 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002598 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2599 const char *vuid;
2600
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002601 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002602 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002603 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2604 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002605 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002606 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002607 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002608 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002609 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002610
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002611 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002612 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002613 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2614 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002615 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002616 const VkExtent3D dest_effective_extent =
2617 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002618 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002619 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002620 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002621 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002622 return skip;
2623}
2624
Jeff Leger178b1e52020-10-05 12:22:23 -04002625// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2626template <typename ImageCopyRegionType>
2627bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2628 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2629 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002630 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002631 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2632 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2633 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002634
2635 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002636 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002637
2638 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002639 const VkExtent3D src_copy_extent = region.extent;
2640 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002641 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2642
Dave Houlton6f9059e2017-05-02 17:15:13 -06002643 bool slice_override = false;
2644 uint32_t depth_slices = 0;
2645
2646 // Special case for copying between a 1D/2D array and a 3D image
2647 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2648 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002649 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002650 slice_override = (depth_slices != 1);
2651 } 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 -07002652 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002653 slice_override = (depth_slices != 1);
2654 }
2655
2656 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002657 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002658 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002659 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002660 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002661 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2662 "be 0 and 1, respectively.",
2663 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 }
2665 }
2666
Dave Houlton533be9f2018-03-26 17:08:30 -06002667 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 -04002668 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002669 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002670 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002671 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002672 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002673 }
2674
Dave Houlton533be9f2018-03-26 17:08:30 -06002675 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002676 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002677 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 -04002678 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002679 }
2680
sfricke-samsung01da6312021-10-20 07:51:32 -07002681 // Source checks that apply only to "blocked images"
2682 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002683 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002684 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002685 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2686 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2687 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002688 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002689 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002690 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002691 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002692 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002693 }
2694
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002695 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002696 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2697 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002698 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002699 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002700 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002701 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2702 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002703 }
2704
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002705 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002706 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2707 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002708 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002709 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002710 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2711 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2712 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002713 }
2714
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002715 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002716 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2717 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002718 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002719 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002720 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2721 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2722 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002723 }
2724 } // Compressed
2725
2726 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002727 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002728 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002729 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002730 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002731 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002732 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002733 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002734 }
2735 }
2736
Dave Houlton533be9f2018-03-26 17:08:30 -06002737 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 -04002738 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002739 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002740 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2741 "and 1, respectively.",
2742 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002743 }
2744
Dave Houlton533be9f2018-03-26 17:08:30 -06002745 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002746 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002747 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 -04002748 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002749 }
2750
sfricke-samsung30b094c2020-05-30 11:42:11 -07002751 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002752 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002753 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2754 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002755 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002756 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002757 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2758 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2759 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002760 }
2761 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002762 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002763 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002764 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002765 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002766 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2767 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2768 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002769 }
2770 }
2771 } else { // Pre maint 1
2772 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002773 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002774 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002775 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002776 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002777 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2778 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002779 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002780 }
Dave Houltonee281a52017-12-08 13:51:02 -07002781 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002782 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002783 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002784 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002785 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2786 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002787 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002788 }
2789 }
2790 }
2791
sfricke-samsung01da6312021-10-20 07:51:32 -07002792 // Dest checks that apply only to "blocked images"
2793 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002794 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002795
2796 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002797 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2798 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2799 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002800 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002801 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002802 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002803 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002804 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002805 }
2806
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002807 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002808 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2809 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002810 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002811 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002812 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002813 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2814 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002815 }
2816
Dave Houltonee281a52017-12-08 13:51:02 -07002817 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2818 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2819 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002820 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002821 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002822 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002823 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2824 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002825 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002826 }
2827
Dave Houltonee281a52017-12-08 13:51:02 -07002828 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2829 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2830 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002831 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002832 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002833 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2834 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2835 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002836 }
2837 } // Compressed
2838 }
2839 return skip;
2840}
2841
Jeff Leger178b1e52020-10-05 12:22:23 -04002842template <typename RegionType>
2843bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2844 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2845 const RegionType *pRegions, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002846 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
2847 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
2848 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002849 const VkFormat src_format = src_image_state->createInfo.format;
2850 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002851 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002852 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002853
Jeff Leger178b1e52020-10-05 12:22:23 -04002854 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07002855 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002856 const char *vuid;
2857
2858 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002859
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002860 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002861
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002862 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002864
2865 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2866 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002867 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002868
Dave Houlton6f9059e2017-05-02 17:15:13 -06002869 bool slice_override = false;
2870 uint32_t depth_slices = 0;
2871
2872 // Special case for copying between a 1D/2D array and a 3D image
2873 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2874 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2875 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002876 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002877 slice_override = (depth_slices != 1);
2878 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2879 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002880 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002881 slice_override = (depth_slices != 1);
2882 }
2883
Jeff Leger178b1e52020-10-05 12:22:23 -04002884 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2885 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2886 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2887 skip |=
2888 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2889 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2890 skip |=
2891 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2892 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002893 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002894 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2895 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002896 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002897 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002898
sfricke-samsung45996a42021-09-16 13:45:27 -07002899 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002900 // No chance of mismatch if we're overriding depth slice count
2901 if (!slice_override) {
2902 // The number of depth slices in srcSubresource and dstSubresource must match
2903 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2904 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002905 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2906 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002907 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002908 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2909 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002910 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002911 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2912 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002913 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2914 "do not match.",
2915 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002916 }
2917 }
2918 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002919 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002920 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002921 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002922 skip |=
2923 LogError(command_buffer, vuid,
2924 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2925 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002926 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002927 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002928
Dave Houltonc991cc92018-03-06 11:08:51 -07002929 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002930 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002931 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2932 // If neither image is multi-plane the aspectMask member of src and dst must match
2933 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2934 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2935 skip |= LogError(command_buffer, vuid,
2936 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2937 "source (0x%x) destination (0x%x).",
2938 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2939 }
2940 } else {
2941 // Source image multiplane checks
2942 uint32_t planes = FormatPlaneCount(src_format);
2943 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2944 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2945 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2946 skip |= LogError(command_buffer, vuid,
2947 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2948 i, aspect);
2949 }
2950 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2951 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2952 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2953 skip |= LogError(command_buffer, vuid,
2954 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2955 i, aspect);
2956 }
2957 // Single-plane to multi-plane
2958 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2959 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2960 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2961 skip |= LogError(command_buffer, vuid,
2962 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2963 func_name, i, aspect);
2964 }
Dave Houltonc991cc92018-03-06 11:08:51 -07002965
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002966 // Dest image multiplane checks
2967 planes = FormatPlaneCount(dst_format);
2968 aspect = region.dstSubresource.aspectMask;
2969 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2970 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2971 skip |= LogError(command_buffer, vuid,
2972 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2973 i, aspect);
2974 }
2975 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2976 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2977 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2978 skip |= LogError(command_buffer, vuid,
2979 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2980 i, aspect);
2981 }
2982 // Multi-plane to single-plane
2983 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
2984 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2985 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2986 skip |= LogError(command_buffer, vuid,
2987 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2988 func_name, i, aspect);
2989 }
2990 }
2991 } else {
2992 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07002993 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2994 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002995 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002996 skip |= LogError(
2997 command_buffer, vuid,
2998 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
2999 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003000 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003001 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003002
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003003 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003004 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003005 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003006 skip |=
3007 LogError(command_buffer, vuid,
3008 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3009 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003010 }
3011
3012 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003013 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003014 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003015 skip |= LogError(
3016 command_buffer, vuid,
3017 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3018 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003019 }
3020
Dave Houltonfc1a4052017-04-27 14:32:45 -06003021 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003022 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003023 if (slice_override) src_copy_extent.depth = depth_slices;
3024 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003025 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003026 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3027 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003028 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003029 "width [%1d].",
3030 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003031 }
3032
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003033 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003034 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3035 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003036 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003037 "height [%1d].",
3038 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003039 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003040 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003041 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3042 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003043 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003044 "depth [%1d].",
3045 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003046 }
3047
Dave Houltonee281a52017-12-08 13:51:02 -07003048 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003049 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003050 if (slice_override) dst_copy_extent.depth = depth_slices;
3051
3052 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003053 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003054 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3055 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003056 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003057 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003058 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003059 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003060 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003061 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3062 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003063 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003064 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003065 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003066 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003067 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003068 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3069 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003070 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003071 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003072 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003073 }
3074
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003075 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3076 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003077 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003078 for (uint32_t j = 0; j < regionCount; j++) {
3079 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003080 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003081 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003082 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003083 }
3084 }
3085 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003086
3087 // 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 -07003088 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003089 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3090 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3091 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003092 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3093 skip |= LogError(command_buffer, vuid,
3094 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3095 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003096 }
3097 } else {
3098 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3099 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3100 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003101 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3102 skip |= LogError(command_buffer, vuid,
3103 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3104 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003105 }
3106 }
3107
3108 // Check if 2D with 3D and depth not equal to 2D layerCount
3109 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3110 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3111 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003112 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3113 skip |= LogError(command_buffer, vuid,
3114 "%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 -08003115 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003116 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003117 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3118 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3119 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003120 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3121 skip |= LogError(command_buffer, vuid,
3122 "%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 -08003123 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003124 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003125 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003126
3127 // Check for multi-plane format compatiblity
3128 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003129 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3130 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3131 : src_format;
3132 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3133 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3134 : dst_format;
3135 const size_t src_format_size = FormatElementSize(src_plane_format);
3136 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3137
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003138 // If size is still zero, then format is invalid and will be caught in another VU
3139 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003140 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3141 skip |= LogError(command_buffer, vuid,
3142 "%s: pRegions[%u] called with non-compatible image formats. "
3143 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3144 func_name, i, string_VkFormat(src_format),
3145 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3146 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003147 }
3148 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003149 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003150
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003151 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3152 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3153 // because because both texels are 4 bytes in size.
3154 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003155 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003156 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Jeff Leger178b1e52020-10-05 12:22:23 -04003157 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3158 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003159 // Depth/stencil formats must match exactly.
3160 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3161 if (src_format != dst_format) {
3162 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003163 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003164 string_VkFormat(src_format), string_VkFormat(dst_format));
3165 }
3166 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003167 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003168 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003169 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003170 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003171 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003172 FormatElementSize(dst_format));
3173 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003174 }
3175 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003176
Dave Houlton33c22b72017-02-28 13:16:02 -07003177 // Source and dest image sample counts must match
3178 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003179 std::stringstream ss;
3180 ss << func_name << " called on image pair with non-identical sample counts.";
3181 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003182 skip |=
3183 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3184 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3185 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003186 }
3187
sfricke-samsung45996a42021-09-16 13:45:27 -07003188 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003189 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3190 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003191 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003192 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003193 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3194 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3195 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003196 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003197 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3198 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3199 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3200 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3201 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3202 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3203 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3204 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3205 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3206 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3207 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3208 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003209
3210 // Validation for VK_EXT_fragment_density_map
3211 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003212 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3213 skip |=
3214 LogError(command_buffer, vuid,
3215 "%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 +02003216 }
3217 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003218 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3219 skip |=
3220 LogError(command_buffer, vuid,
3221 "%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 +02003222 }
3223
sfricke-samsung45996a42021-09-16 13:45:27 -07003224 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003225 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3226 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3227 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3228 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003229 }
sfricke-samsung85584a72021-09-30 21:43:38 -07003230 skip |= ValidateCmd(cb_node, cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003231 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003232
3233 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003234 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003235 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3236 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3237 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003238 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003239 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3240 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3241
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003242 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003243 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003244 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003245 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3246 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003247 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003248 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003249 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003250 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003251 }
3252
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003253 return skip;
3254}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003255
Jeff Leger178b1e52020-10-05 12:22:23 -04003256bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3257 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3258 const VkImageCopy *pRegions) const {
3259 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3260 COPY_COMMAND_VERSION_1);
3261}
3262
3263bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3264 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3265 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3266 COPY_COMMAND_VERSION_2);
3267}
3268
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003269void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3270 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3271 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003272 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3273 pRegions);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003274 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3275 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3276 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003277
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003278 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003279 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003280 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3281 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003282 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003283}
3284
Jeff Leger178b1e52020-10-05 12:22:23 -04003285void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3286 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003287 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3288 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3289 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003290
3291 // Make sure that all image slices are updated to correct layout
3292 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003293 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3294 pCopyImageInfo->srcImageLayout);
3295 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3296 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003297 }
3298}
3299
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003300// Returns true if sub_rect is entirely contained within rect
3301static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3302 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 -07003303 (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 -07003304 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003305 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003306 return true;
3307}
3308
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003309bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003310 const IMAGE_VIEW_STATE* image_view_state,
3311 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003312 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003313
3314 for (uint32_t j = 0; j < rect_count; j++) {
3315 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003316 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003317 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3318 "the current render pass instance.",
3319 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003320 }
3321
3322 if (image_view_state) {
3323 // The layers specified by a given element of pRects must be contained within every attachment that
3324 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003325 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003326 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3327 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003328 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003329 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3330 "of pAttachment[%d].",
3331 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003332 }
3333 }
3334 }
3335 return skip;
3336}
3337
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003338bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3339 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003340 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003341 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003342 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 +02003343 if (!cb_node) return skip;
3344
sfricke-samsung85584a72021-09-30 21:43:38 -07003345 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003346
3347 // Validate that attachment is in reference list of active subpass
3348 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003349 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003350 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003351 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003352 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003353 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003354
John Zulauf3a548ef2019-02-01 16:14:07 -07003355 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3356 auto clear_desc = &pAttachments[attachment_index];
3357 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003358 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003359
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003360 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3361 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3362 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3363 attachment_index);
3364 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3365 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3366 skip |=
3367 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3368 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3369 attachment_index);
3370 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003371 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003372 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003373 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3374 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3375 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3376 skip |= LogError(
3377 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3378 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3379 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3380 attachment_index, clear_desc->colorAttachment,
3381 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3382 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003383
amhagana448ea52021-11-02 14:09:14 -04003384 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3385 }
3386 } else {
3387 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3388 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3389 " subpass %u. colorAttachmentCount=%u",
3390 attachment_index, clear_desc->colorAttachment,
3391 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3392 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003393 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003394 }
John Zulauff2582972019-02-09 14:53:30 -07003395 fb_attachment = color_attachment;
3396
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003397 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3398 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3399 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3400 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3401 "of a color attachment.",
3402 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003403 }
3404 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003405 bool subpass_depth = false;
3406 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003407 if (subpass_desc) {
3408 if (subpass_desc->pDepthStencilAttachment &&
3409 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3410 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3411 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3412 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003413 }
amhagana448ea52021-11-02 14:09:14 -04003414 if (!subpass_desc->pDepthStencilAttachment ||
3415 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3416 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3417 skip |= LogError(
3418 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3419 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3420 "depth attachment in subpass",
3421 attachment_index);
3422 }
3423 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003424 skip |= LogError(
3425 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3426 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003427 "stencil attachment in subpass",
3428 attachment_index);
3429 }
3430 } else {
3431 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003432 }
amhagana448ea52021-11-02 14:09:14 -04003433 if (subpass_depth) {
3434 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3435 "vkCmdClearAttachments()");
3436 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003437 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003438 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003439 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003440 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3441 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3442 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3443 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003444 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003445 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003446 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003447
3448 // Once the framebuffer attachment is found, can get the image view state
3449 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3450 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003451 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003452 if (image_view_state != nullptr) {
3453 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3454 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3455 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3456 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3457 }
3458 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003459
amhagana448ea52021-11-02 14:09:14 -04003460 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3461 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3462 for (uint32_t i = 0; i < rectCount; ++i) {
3463 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3464 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3465 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3466 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3467 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3468 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003469 }
3470 }
3471 }
John Zulauf441558b2019-08-12 11:47:39 -06003472 }
3473 return skip;
3474}
3475
3476void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3477 const VkClearAttachment *pAttachments, uint32_t rectCount,
3478 const VkClearRect *pRects) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003479 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003480 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003481 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003482 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3483 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3484 const auto clear_desc = &pAttachments[attachment_index];
3485 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3486 int image_index = -1;
3487 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3488 (clear_desc->colorAttachment < colorAttachmentCount)) {
3489 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3490 }
3491 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3492 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3493 }
3494 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3495 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3496 }
amhagana448ea52021-11-02 14:09:14 -04003497
Aaron Haganc6bafff2021-11-29 23:30:07 -05003498 if (image_index != -1) {
3499 if (!clear_rect_copy) {
3500 // We need a copy of the clear rectangles that will persist until the last lambda executes
3501 // but we want to create it as lazily as possible
3502 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003503 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003504 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3505 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3506 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3507 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3508 const FRAMEBUFFER_STATE *fb) {
3509 assert(rectCount == clear_rect_copy->size());
3510 bool skip = false;
3511 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3512 if (image_index != -1) {
3513 image_view_state = (*prim_cb->active_attachments)[image_index];
3514 }
3515 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3516 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3517 rectCount, clear_rect_copy->data());
3518 return skip;
3519 };
3520 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003521 }
amhagana448ea52021-11-02 14:09:14 -04003522 }
3523 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003524 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003525 {
3526 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3527 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003528
amhagana448ea52021-11-02 14:09:14 -04003529 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3530 const auto clear_desc = &pAttachments[attachment_index];
3531 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3532 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3533 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3534 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3535 }
3536 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3537 subpass_desc->pDepthStencilAttachment) {
3538 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3539 }
3540 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3541 if (!clear_rect_copy) {
3542 // We need a copy of the clear rectangles that will persist until the last lambda executes
3543 // but we want to create it as lazily as possible
3544 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3545 }
3546 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3547 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003548 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3549 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3550 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003551 assert(rectCount == clear_rect_copy->size());
3552 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3553 bool skip = false;
3554 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3555 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3556 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3557 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003558 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3559 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003560 return skip;
3561 };
3562 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3563 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003564 }
3565 }
3566 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003567}
3568
Jeff Leger178b1e52020-10-05 12:22:23 -04003569template <typename RegionType>
3570bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3571 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3572 const RegionType *pRegions, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003573 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3574 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
3575 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003576 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003577 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE2KHR : CMD_RESOLVEIMAGE;
3578 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003579 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003580
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003581 bool skip = false;
3582 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003583 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3584 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3585 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3586 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
sfricke-samsung85584a72021-09-30 21:43:38 -07003587 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003588 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3589 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3590 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3591 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3592 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3593 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3594 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3595 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003596
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003597 // Validation for VK_EXT_fragment_density_map
3598 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003599 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003600 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003601 "%s: srcImage must not have been created with flags containing "
3602 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3603 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003604 }
3605 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003606 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003607 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003608 "%s: dstImage must not have been created with flags containing "
3609 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3610 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003611 }
3612
Cort Stratton7df30962018-05-17 19:45:57 -07003613 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003614 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003615 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003616 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003617 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003618 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003619 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3620 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003621 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003622 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003623 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3624 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003625 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003626 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3627 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003628 // For each region, the number of layers in the image subresource should not be zero
3629 // For each region, src and dest image aspect must be color only
3630 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003631 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003632 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3633 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3635 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3636 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003637 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003638 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3639 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003640 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003641 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3642 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3643 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3644 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3645 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3646 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003647 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003648 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3649 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003650 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003651 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003652
3653 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003654 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003655 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3656 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003657 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003658 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003659 }
Cort Stratton7df30962018-05-17 19:45:57 -07003660 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003661 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3662 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003663 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003664 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003665 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3666 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003667 }
3668
3669 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3670 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3671
3672 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003673 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003674 LogObjectList objlist(cb_node->commandBuffer());
3675 objlist.add(src_image_state->image());
3676 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003677 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3678 skip |= LogError(objlist, vuid,
3679 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003680 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003681 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003682 }
3683 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003684 LogObjectList objlist(cb_node->commandBuffer());
3685 objlist.add(src_image_state->image());
3686 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003687 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3688 skip |= LogError(objlist, vuid,
3689 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003690 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003691 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003692 }
3693 }
3694
3695 if (VK_IMAGE_TYPE_1D == src_image_type) {
3696 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003697 LogObjectList objlist(cb_node->commandBuffer());
3698 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003699 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3700 skip |= LogError(objlist, vuid,
3701 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003702 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003703 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003704 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003705 }
3706 }
3707 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3708 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003709 LogObjectList objlist(cb_node->commandBuffer());
3710 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003711 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3712 skip |= LogError(objlist, vuid,
3713 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003714 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003715 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003716 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003717 }
3718 }
3719
3720 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3721 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003722 LogObjectList objlist(cb_node->commandBuffer());
3723 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003724 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3725 skip |= LogError(objlist, vuid,
3726 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003727 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003728 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003729 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003730 }
3731 }
3732 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3733 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003734 LogObjectList objlist(cb_node->commandBuffer());
3735 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003736 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3737 skip |= LogError(objlist, vuid,
3738 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003739 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003740 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003741 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003742 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003743 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003744
3745 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003746 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003747 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3748 // developer
3749 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3750 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003751 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003752 LogObjectList objlist(cb_node->commandBuffer());
3753 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003754 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3755 skip |= LogError(objlist, vuid,
3756 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003757 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003758 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003759 region.extent.width, subresource_extent.width);
3760 }
3761
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003762 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003763 LogObjectList objlist(cb_node->commandBuffer());
3764 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003765 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3766 skip |= LogError(objlist, vuid,
3767 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003768 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003769 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003770 region.extent.height, subresource_extent.height);
3771 }
3772
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003773 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003774 LogObjectList objlist(cb_node->commandBuffer());
3775 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003776 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3777 skip |= LogError(objlist, vuid,
3778 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003779 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003780 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003781 region.extent.depth, subresource_extent.depth);
3782 }
3783 }
3784
3785 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003786 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003787 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3788 // developer
3789 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3790 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003791 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003792 LogObjectList objlist(cb_node->commandBuffer());
3793 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003794 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3795 skip |= LogError(objlist, vuid,
3796 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003797 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003798 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003799 region.extent.width, subresource_extent.width);
3800 }
3801
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003802 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003803 LogObjectList objlist(cb_node->commandBuffer());
3804 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003805 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3806 skip |= LogError(objlist, vuid,
3807 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003808 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003809 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003810 region.extent.height, subresource_extent.height);
3811 }
3812
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003813 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003814 LogObjectList objlist(cb_node->commandBuffer());
3815 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003816 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3817 skip |= LogError(objlist, vuid,
3818 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003819 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003820 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003821 region.extent.depth, subresource_extent.depth);
3822 }
3823 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003824 }
3825
3826 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003827 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003828 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 -04003829 func_name, string_VkFormat(src_image_state->createInfo.format),
3830 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003831 }
3832 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003833 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003834 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003835 string_VkImageType(src_image_state->createInfo.imageType),
3836 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003837 }
3838 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003839 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003840 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 -07003841 }
3842 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003843 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003844 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 -04003845 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003846 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003847 } else {
3848 assert(0);
3849 }
3850 return skip;
3851}
3852
Jeff Leger178b1e52020-10-05 12:22:23 -04003853bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3854 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3855 const VkImageResolve *pRegions) const {
3856 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3857 COPY_COMMAND_VERSION_1);
3858}
3859
3860bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3861 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3862 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3863 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3864 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3865}
3866
3867template <typename RegionType>
3868bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3869 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3870 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003871 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
3872 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
3873 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003874
Jeff Leger178b1e52020-10-05 12:22:23 -04003875 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003876 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE2KHR : CMD_BLITIMAGE;
3877 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003878
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003879 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003880 if (cb_node) {
sfricke-samsung85584a72021-09-30 21:43:38 -07003881 skip |= ValidateCmd(cb_node, cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07003882 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003883 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003884 const char *vuid;
3885 const char *location;
3886 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3887 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3888 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3889 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3890 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3891 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3892 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3893 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3894 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3895 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3896 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3897 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3898 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3899 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3900 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3901 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07003902 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003903 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3904 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3905 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3906 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3907 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3908 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3909 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3910 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3911 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3912 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003913
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003914 // Validation for VK_EXT_fragment_density_map
3915 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003916 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003917 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3919 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003920 }
3921 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003922 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003923 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003924 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3925 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003926 }
3927
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003928 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003929
Dave Houlton33c2d252017-06-09 17:08:32 -06003930 VkFormat src_format = src_image_state->createInfo.format;
3931 VkFormat dst_format = dst_image_state->createInfo.format;
3932 VkImageType src_type = src_image_state->createInfo.imageType;
3933 VkImageType dst_type = dst_image_state->createInfo.imageType;
3934
Cort Stratton186b1a22018-05-01 20:18:06 -04003935 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003936 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3937 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3938 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003939 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003941 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003943 }
3944
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003945 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003946 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04003947 skip |= LogError(device, vuid,
3948 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003949 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003950 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003951 }
3952
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003953 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003954 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04003955 skip |= LogError(device, vuid,
3956 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003957 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003958 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003959 }
3960
ziga-lunarg52604a12021-09-09 16:02:05 +02003961 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003962 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003963 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02003964 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003965 }
3966
Dave Houlton33c2d252017-06-09 17:08:32 -06003967 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08003968 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003969 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003970 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003971 << "the other one must also have unsigned integer format. "
3972 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003973 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003974 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003975 }
3976
3977 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08003978 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003979 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003980 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003981 << "the other one must also have signed integer format. "
3982 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003983 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003984 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003985 }
3986
3987 // Validate filter for Depth/Stencil formats
3988 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3989 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003990 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003991 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003992 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003993 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003994 }
3995
3996 // Validate aspect bits and formats for depth/stencil images
3997 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3998 if (src_format != dst_format) {
3999 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004000 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 -06004001 << "stencil, the other one must have exactly the same format. "
4002 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4003 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04004004 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004005 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004006 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004007 } // Depth or Stencil
4008
4009 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004010 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004011 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004012 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4013 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004014 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004015 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4016 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004017 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004018 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4020 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004021 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4023 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004024 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004025 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004026 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004027 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004028 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004029 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4030 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004031 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004032 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4033 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4034 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4035 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4036 skip |=
4037 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4038 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4039 skip |=
4040 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4041 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004042 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004043 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4044 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004045 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004046 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004047 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004048 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4049 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004050 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004051 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004052 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004053 }
Dave Houlton48989f32017-05-26 15:01:46 -06004054 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4055 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004056 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004057 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004058 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004059 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004060
4061 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004062 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004063 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4064 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004065 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004066 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004067 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004068
Dave Houlton48989f32017-05-26 15:01:46 -06004069 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004070 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4071 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004072 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004073 }
Dave Houlton48989f32017-05-26 15:01:46 -06004074
Dave Houlton33c2d252017-06-09 17:08:32 -06004075 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004076 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004077 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004078 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004079 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004080 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004081 }
4082
4083 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004084 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004085 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004086 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4087 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004088 }
4089
Dave Houlton48989f32017-05-26 15:01:46 -06004090 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004091 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004092 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004093 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004094 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004095 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004096 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4097 "of (%1d, %1d). These must be (0, 1).",
4098 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004099 }
4100 }
4101
Dave Houlton33c2d252017-06-09 17:08:32 -06004102 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004103 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004104 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004105 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004106 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4107 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4108 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004109 }
4110 }
4111
Dave Houlton33c2d252017-06-09 17:08:32 -06004112 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004113 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4114 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004115 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004116 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004117 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004118 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4119 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004120 }
4121 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4122 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004123 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004124 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004125 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004126 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4127 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004128 }
4129 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4130 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004131 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004132 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004133 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004134 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4135 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004136 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004137 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004138 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004139 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004140 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004141 }
Dave Houlton48989f32017-05-26 15:01:46 -06004142
4143 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004144 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004145 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004146 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004147 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004148 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004149 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4150 "(%1d, %1d). These must be (0, 1).",
4151 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004152 }
4153 }
4154
Dave Houlton33c2d252017-06-09 17:08:32 -06004155 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004156 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004157 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004158 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004159 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004160 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004161 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004162 }
4163 }
4164
Dave Houlton33c2d252017-06-09 17:08:32 -06004165 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004166 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4167 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004168 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004169 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004170 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004171 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4172 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004173 }
4174 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4175 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004176 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004177 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004178 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004179 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4180 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004181 }
4182 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4183 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004184 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004185 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004186 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004187 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4188 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004189 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004190 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004191 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004192 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004193 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004194 }
4195
Dave Houlton33c2d252017-06-09 17:08:32 -06004196 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4197 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4198 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004199 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004200 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004201 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4202 "layerCount other than 1.",
4203 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004204 }
4205 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004206 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004207 } else {
4208 assert(0);
4209 }
4210 return skip;
4211}
4212
Jeff Leger178b1e52020-10-05 12:22:23 -04004213bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4214 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4215 const VkImageBlit *pRegions, VkFilter filter) const {
4216 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4217 COPY_COMMAND_VERSION_1);
4218}
4219
4220bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4221 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4222 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4223 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4224}
4225
4226template <typename RegionType>
4227void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4228 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4229 VkFilter filter) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004230 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
4231 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4232 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004233
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004234 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004235 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004236 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4237 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004238 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004239}
4240
Jeff Leger178b1e52020-10-05 12:22:23 -04004241void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4242 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4243 const VkImageBlit *pRegions, VkFilter filter) {
4244 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4245 pRegions, filter);
4246 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4247}
4248
4249void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4250 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4251 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4252 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4253 pBlitImageInfo->filter);
4254}
4255
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004256GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004257 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004258 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004259 if (!layout_map) {
4260 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004261 }
John Zulauf17708d02021-02-22 11:20:58 -07004262 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004263}
4264
Jeremy Gebben6335df62021-11-01 10:50:13 -06004265const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4266 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004267 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004268 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004269 }
4270 return nullptr;
4271}
4272
Jeremy Gebben53631302021-04-13 16:46:37 -06004273// Helper to update the Global or Overlay layout map
4274struct GlobalLayoutUpdater {
4275 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4276 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4277 dst = src.current_layout;
4278 return true;
4279 }
4280 return false;
4281 }
4282
4283 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4284 layer_data::optional<VkImageLayout> result;
4285 if (src.current_layout != image_layout_map::kInvalidLayout) {
4286 result.emplace(src.current_layout);
4287 }
4288 return result;
4289 }
4290};
4291
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004292// 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 -07004293bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
4294 const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004295 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004296 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004297 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004298 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004299 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004300 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004301 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004302 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004303 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004304 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004305 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004306
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004307 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben6335df62021-11-01 10:50:13 -06004308 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004309 if (global_map == nullptr) {
4310 global_map = &empty_map;
4311 }
4312
4313 // Note: don't know if it would matter
4314 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4315
Jeremy Gebben53631302021-04-13 16:46:37 -06004316 auto pos = layout_map.begin();
4317 const auto end = layout_map.end();
4318 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4319 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004320 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004321 VkImageLayout initial_layout = pos->second.initial_layout;
4322 assert(initial_layout != image_layout_map::kInvalidLayout);
4323 if (initial_layout == image_layout_map::kInvalidLayout) {
4324 continue;
4325 }
4326
John Zulauf2076e812020-01-08 14:55:54 -07004327 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004328
John Zulauf2076e812020-01-08 14:55:54 -07004329 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 -07004330 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004331 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004332 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004333 image_layout = current_layout->pos_B->lower_bound->second;
4334 }
4335 const auto intersected_range = pos->first & current_layout->range;
4336 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4337 // TODO: Set memory invalid which is in mem_tracker currently
4338 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004339 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4340 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004341 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004342 // We can report all the errors for the intersected range directly
4343 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004344 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004345 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004346 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004347 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004348 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004349 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004350 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004351 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004352 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004353 }
4354 }
John Zulauf2076e812020-01-08 14:55:54 -07004355 if (pos->first.includes(intersected_range.end)) {
4356 current_layout.seek(intersected_range.end);
4357 } else {
4358 ++pos;
4359 if (pos != end) {
4360 current_layout.seek(pos->first.begin);
4361 }
4362 }
John Zulauff660ad62019-03-23 07:16:05 -06004363 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004364 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004365 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004366 }
John Zulauff660ad62019-03-23 07:16:05 -06004367
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004368 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004369}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004370
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004371void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004372 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004373 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004374 const auto &subres_map = layout_map_entry.second;
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004375 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004376 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004377 }
4378}
4379
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004380// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004381// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4382// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004383bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4384 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004385 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004386 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004387 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4388
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004389 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004390 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4391 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004392 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004393 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4394 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4395 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004396 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004397 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004398 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004399 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004400 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4401 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004402 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004403 string_VkImageLayout(first_layout));
4404 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4405 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004406 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004407 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004409 }
4410 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004411
4412 // Same as above for loadOp, but for stencilLoadOp
4413 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4414 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4415 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4416 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4417 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004418 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004419 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004420 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004421 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4422 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004423 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004424 string_VkImageLayout(first_layout));
4425 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4426 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4427 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004428 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004429 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004430 }
4431 }
4432
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004433 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004434}
4435
Mark Lobodzinski96210742017-02-09 10:33:46 -07004436// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4437// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004438template <typename T1>
4439bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4440 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4441 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004442 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004443 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004444 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004445 if (strict) {
4446 correct_usage = ((actual & desired) == desired);
4447 } else {
4448 correct_usage = ((actual & desired) != 0);
4449 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004450
Mark Lobodzinski96210742017-02-09 10:33:46 -07004451 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004452 // All callers should have a valid VUID
4453 assert(msgCode != kVUIDUndefined);
4454 skip =
4455 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4456 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004457 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004458 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004459}
4460
4461// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4462// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004463bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004464 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004465 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004466 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004467}
4468
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004469bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004470 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004471 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004472 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4473 if ((image_format_features & desired) != desired) {
4474 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004475 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004476 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004477 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4478 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4479 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004480 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004481 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004482 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004483 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4484 "with tiling %s.",
4485 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004486 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004487 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004488 }
4489 }
4490 return skip;
4491}
4492
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004493bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004494 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004495 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004496 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004497 // layerCount must not be zero
4498 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004499 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004500 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004501 }
4502 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004503 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004504 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004505 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004506 }
4507 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004508 if ((apsect_mask & VK_IMAGE_ASPECT_COLOR_BIT) && (apsect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004509 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004510 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4511 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4512 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004513 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004514 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4515 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4516 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004517 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004518 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4519 member);
4520 }
Cort Strattond619a302018-05-17 19:46:32 -07004521 return skip;
4522}
4523
Mark Lobodzinski96210742017-02-09 10:33:46 -07004524// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4525// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004526bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004527 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004528 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004529 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004530}
4531
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004532bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004533 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004534 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004535
4536 const VkDeviceSize &range = pCreateInfo->range;
4537 if (range != VK_WHOLE_SIZE) {
4538 // Range must be greater than 0
4539 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004540 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004541 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004542 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4543 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004544 }
4545 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004546 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4547 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004548 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004549 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004550 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4551 "(%" PRIu32 ").",
4552 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004553 }
4554 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004555 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004556 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004557 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004558 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4559 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4560 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004561 }
4562 // The sum of range and offset must be less than or equal to the size of buffer
4563 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004564 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004565 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004566 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4567 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4568 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004569 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004570 } else {
4571 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4572
4573 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4574 // VkPhysicalDeviceLimits::maxTexelBufferElements
4575 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4576 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004577 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004578 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4579 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4580 "), divided by the element size of the format (%" PRIu32
4581 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4582 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4583 device_limits->maxTexelBufferElements);
4584 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004585 }
4586 return skip;
4587}
4588
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004589bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004590 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004591 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004592 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4593 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004594 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004595 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004596 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4597 "be supported for uniform texel buffers",
4598 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004599 }
4600 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4601 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004602 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004603 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004604 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4605 "be supported for storage texel buffers",
4606 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004607 }
4608 return skip;
4609}
4610
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004611bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004612 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004613 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004614
Dave Houltond8ed0212018-05-16 17:18:24 -06004615 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004616
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004617 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004618 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004619 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004620 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004621 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4622 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004623 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004624 }
4625 }
4626
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004627 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004628 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004629 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004630 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004632 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4633 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004634 }
4635 }
4636
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004637 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4638 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4639 if (pCreateInfo->flags &
4640 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4641 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4642 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4643 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4644 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4645 }
4646 }
4647
Mike Schuchardt2df08912020-12-15 16:28:09 -08004648 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004649 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004650 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004651 skip |= LogError(
4652 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004653 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004654 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004655 }
4656
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004657 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004658 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4659 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4660 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004661 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004662 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004663 }
4664
sfricke-samsungedce77a2020-07-03 22:35:13 -07004665 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4666 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4667 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4668 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4669 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4670 }
4671 const VkBufferCreateFlags invalid_flags =
4672 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4673 if ((pCreateInfo->flags & invalid_flags) != 0) {
4674 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4675 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4676 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4677 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4678 }
4679 }
4680
Mark Lobodzinski96210742017-02-09 10:33:46 -07004681 return skip;
4682}
4683
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004684bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004685 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004686 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004687 const auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004688
4689 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4690 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4691 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4692 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4693 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4694 "defined sizes for alignment, replace with a color format.",
4695 string_VkFormat(pCreateInfo->format));
4696 }
4697
Mark Lobodzinski96210742017-02-09 10:33:46 -07004698 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4699 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004700 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004701 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4702 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004703 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004704 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4705 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4706 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004707
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004708 // Buffer view offset must be less than the size of buffer
4709 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004710 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004711 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004712 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4713 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004714 }
4715
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004716 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004717 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4718 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4719 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004720 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4721 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4722 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004723 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004724 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004725 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4726 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004727 }
4728
4729 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004730 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4731 if ((element_size % 3) == 0) {
4732 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004733 }
4734 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004735 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004736 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4737 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004738 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004739 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004740 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004741 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004742 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004743 "vkCreateBufferView(): If buffer was created with usage containing "
4744 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004745 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4746 ") must be a multiple of the lesser of "
4747 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4748 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4749 "(%" PRId32
4750 ") is VK_TRUE, the size of a texel of the requested format. "
4751 "If the size of a texel is a multiple of three bytes, then the size of a "
4752 "single component of format is used instead",
4753 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4754 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4755 }
4756 }
4757 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004758 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004759 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4760 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004761 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004762 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004763 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004764 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004765 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004766 "vkCreateBufferView(): If buffer was created with usage containing "
4767 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004768 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4769 ") must be a multiple of the lesser of "
4770 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4771 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4772 "(%" PRId32
4773 ") is VK_TRUE, the size of a texel of the requested format. "
4774 "If the size of a texel is a multiple of three bytes, then the size of a "
4775 "single component of format is used instead",
4776 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4777 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4778 }
4779 }
4780 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004781
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004782 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004783
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004784 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004785 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004786 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004787}
4788
Mark Lobodzinski602de982017-02-09 11:01:33 -07004789// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004790bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004791 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004792 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004793 const auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung79b00482020-04-01 21:15:50 -07004794 // checks color format and (single-plane or non-disjoint)
4795 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004796 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004797 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004798 skip |= LogError(
4799 image, vuid,
4800 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4801 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004802 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004803 skip |= LogError(image, vuid,
4804 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4805 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4806 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004807 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004808 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004809 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004810 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004811 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4812 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4813 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004814 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004815 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004816 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4817 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4818 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004819 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004820 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004821 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004822 skip |= LogError(image, vuid,
4823 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4824 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4825 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004826 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004827 skip |= LogError(image, vuid,
4828 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4829 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4830 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004831 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004832 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004833 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004834 skip |= LogError(image, vuid,
4835 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4836 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4837 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004838 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004839 skip |= LogError(image, vuid,
4840 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4841 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4842 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004843 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004844 } else if (FormatIsMultiplane(format)) {
4845 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4846 if (3 == FormatPlaneCount(format)) {
4847 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4848 }
4849 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004850 skip |= LogError(image, vuid,
4851 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4852 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4853 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004854 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004855 }
4856 return skip;
4857}
4858
ziga-lunarg04e94b32021-10-03 01:42:37 +02004859bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
4860 bool skip = false;
4861
ziga-lunarg04e94b32021-10-03 01:42:37 +02004862 return skip;
4863}
4864
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004865bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4866 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004867 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004868 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004869 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004870
4871 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004872 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004873 skip |= LogError(image, errorCodes.base_mip_err,
4874 "%s: %s.baseMipLevel (= %" PRIu32
4875 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4876 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004877 }
Petr Kraus4d718682017-05-18 03:38:41 +02004878
Petr Krausffa94af2017-08-08 21:46:02 +02004879 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4880 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004881 skip |=
4882 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004883 } else {
4884 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004885
Petr Krausffa94af2017-08-08 21:46:02 +02004886 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004887 skip |= LogError(image, errorCodes.mip_count_err,
4888 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4889 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4890 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4891 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004892 }
Petr Kraus4d718682017-05-18 03:38:41 +02004893 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004894 }
Petr Kraus4d718682017-05-18 03:38:41 +02004895
4896 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004897 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004898 skip |= LogError(image, errorCodes.base_layer_err,
4899 "%s: %s.baseArrayLayer (= %" PRIu32
4900 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4901 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004902 }
Petr Kraus4d718682017-05-18 03:38:41 +02004903
Petr Krausffa94af2017-08-08 21:46:02 +02004904 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4905 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004906 skip |=
4907 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004908 } else {
4909 const uint64_t necessary_layer_count =
4910 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004911
Petr Krausffa94af2017-08-08 21:46:02 +02004912 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004913 skip |= LogError(image, errorCodes.layer_count_err,
4914 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4915 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4916 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4917 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004918 }
Petr Kraus4d718682017-05-18 03:38:41 +02004919 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004920 }
Petr Kraus4d718682017-05-18 03:38:41 +02004921
ziga-lunargb4e90752021-08-02 13:58:29 +02004922 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4923 if (subresourceRange.aspectMask &
4924 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4925 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4926 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4927 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4928 cmd_name);
4929 }
4930 }
4931
Mark Lobodzinski602de982017-02-09 11:01:33 -07004932 return skip;
4933}
4934
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004935bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004936 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004937 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004938 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004939 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004940 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 +02004941
David McFarland2853f2f2020-11-30 15:50:39 -04004942 uint32_t image_layer_count;
4943
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004944 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004945 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004946 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004947 image_layer_count = extent.depth;
4948 } else {
4949 image_layer_count = image_state->createInfo.arrayLayers;
4950 }
4951
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004952 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004953
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004954 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4955 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4956 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4957 subresource_range_error_codes.base_layer_err =
4958 is_khr_maintenance1
4959 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4960 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4961 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4962 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4963 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4964 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004965
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004966 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004967 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004968 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004969}
4970
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004971bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004972 const VkImageSubresourceRange &subresourceRange,
4973 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004974 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4975 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4976 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4977 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4978 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004979
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004980 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004981 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004982 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004983}
4984
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004985bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004986 const VkImageSubresourceRange &subresourceRange,
4987 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004988 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4989 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4990 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4991 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4992 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004993
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004994 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004995 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004996 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004997}
4998
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07004999bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005000 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005001 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005002 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005003 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005004}
5005
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005006namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005007using sync_vuid_maps::GetBarrierQueueVUID;
5008using sync_vuid_maps::kQueueErrorSummary;
5009using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005010
5011class ValidatorState {
5012 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005013 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005014 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5015 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005016 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005017 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005018 barrier_handle_(barrier_handle),
5019 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005020 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5021 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5022
5023 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5024 // 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 -07005025 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5026 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005027 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005028 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5029 loc_.Message().c_str(), GetTypeString(),
5030 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5031 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005032 }
5033
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005034 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5035 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005036 const char *src_annotation = GetFamilyAnnotation(src_family);
5037 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5038 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005039 objects_, val_code,
5040 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5041 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5042 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005043 }
5044
5045 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5046 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5047 // application input.
5048 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5049 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005050 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005051 uint32_t queue_family = queue_state->queueFamilyIndex;
5052 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005053 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005054 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5055 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5056 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005057 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005058 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005059 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005060 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005061 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005062 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005063 }
5064 return false;
5065 }
5066 // Logical helpers for semantic clarity
5067 inline bool KhrExternalMem() const { return mem_ext_; }
5068 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5069 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5070 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5071 }
5072
5073 // Helpers for LogMsg
5074 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5075
5076 // Descriptive text for the various types of queue family index
5077 const char *GetFamilyAnnotation(uint32_t family) const {
5078 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5079 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5080 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5081 const char *valid = " (VALID)";
5082 const char *invalid = " (INVALID)";
5083 switch (family) {
5084 case VK_QUEUE_FAMILY_EXTERNAL:
5085 return external;
5086 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5087 return foreign;
5088 case VK_QUEUE_FAMILY_IGNORED:
5089 return ignored;
5090 default:
5091 if (IsValid(family)) {
5092 return valid;
5093 }
5094 return invalid;
5095 };
5096 }
5097 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5098 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5099
5100 protected:
5101 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005102 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005103 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005104 const VulkanTypedHandle barrier_handle_;
5105 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005106 const uint32_t limit_;
5107 const bool mem_ext_;
5108};
5109
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005110bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005111 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5112 bool skip = false;
5113
5114 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5115 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5116 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5117 if (val.KhrExternalMem()) {
5118 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005119 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5120 // this requirement is removed by VK_KHR_synchronization2
5121 if (!(src_ignored || dst_ignored) && !sync2) {
5122 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005123 }
5124 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5125 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005126 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005127 }
5128 } else {
5129 // VK_SHARING_MODE_EXCLUSIVE
5130 if (src_queue_family != dst_queue_family) {
5131 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005132 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005133 }
5134 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005135 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005136 }
5137 }
5138 }
5139 } else {
5140 // No memory extension
5141 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005142 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5143 // this requirement is removed by VK_KHR_synchronization2
5144 if ((!src_ignored || !dst_ignored) && !sync2) {
5145 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005146 }
5147 } else {
5148 // VK_SHARING_MODE_EXCLUSIVE
5149 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005150 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005151 }
5152 }
5153 }
5154 return skip;
5155}
5156} // namespace barrier_queue_families
5157
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005158bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5159 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005160 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5161 uint32_t dst_queue_family) {
5162 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005163 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5164 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005165}
5166
5167// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005168template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005169bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5170 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005171 // State data is required
5172 if (!state_data) {
5173 return false;
5174 }
5175
5176 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005177 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005178 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005179 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5180 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005181 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005182}
5183
5184// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005185template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005186bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5187 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005188 // State data is required
5189 if (!state_data) {
5190 return false;
5191 }
5192
5193 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005194 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005195 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005196 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5197 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005198 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5199}
5200
5201template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005202bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005203 const Barrier &mem_barrier) const {
5204 using sync_vuid_maps::BufferError;
5205 using sync_vuid_maps::GetBufferBarrierVUID;
5206
5207 bool skip = false;
5208
5209 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5210
5211 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005212 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005213 if (buffer_state) {
5214 auto buf_loc = loc.dot(Field::buffer);
5215 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005216 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005217
5218 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5219
5220 auto buffer_size = buffer_state->createInfo.size;
5221 if (mem_barrier.offset >= buffer_size) {
5222 auto offset_loc = loc.dot(Field::offset);
5223 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5224
5225 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5226 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5227 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5228 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5229 auto size_loc = loc.dot(Field::size);
5230 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5231 skip |= LogError(objects, vuid,
5232 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5233 ".",
5234 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5235 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5236 }
5237 if (mem_barrier.size == 0) {
5238 auto size_loc = loc.dot(Field::size);
5239 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5240 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5241 report_data->FormatHandle(mem_barrier.buffer).c_str());
5242 }
5243 }
5244 return skip;
5245}
5246
5247template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005248bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005249 const Barrier &mem_barrier) const {
5250 bool skip = false;
5251
5252 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5253
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005254 bool is_ilt = true;
5255 if (enabled_features.synchronization2_features.synchronization2) {
5256 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5257 }
5258
5259 if (is_ilt) {
5260 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5261 auto layout_loc = loc.dot(Field::newLayout);
5262 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5263 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005264 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005265 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005266 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005267 }
5268
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005269 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005270 if (image_data) {
5271 auto image_loc = loc.dot(Field::image);
5272
John Zulaufbea70432021-02-23 07:03:12 -07005273 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005274
5275 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5276
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005277 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005278 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005279
5280 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
ziga-lunarg04e94b32021-10-03 01:42:37 +02005281 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005282 }
5283 return skip;
5284}
5285
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005286bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5287 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5288 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005289 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5290 const VkImageMemoryBarrier *pImageMemBarriers) const {
5291 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005292 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005293
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005294 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5295 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005296 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005297 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005298 }
5299 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5300 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005301 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005302 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005303 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5304 }
5305 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005306 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005307 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5308 }
5309 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5310 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005311 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005312 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005313 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5314 }
5315 return skip;
5316}
5317
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005318bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005319 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005320 bool skip = false;
5321
5322 if (cb_state->activeRenderPass) {
5323 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5324 if (skip) return true; // Early return to avoid redundant errors from below calls
5325 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005326 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5327 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005328 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005329 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005330 }
5331 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5332 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005333 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005334 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005335 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5336 }
5337 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005338 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005339 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5340 }
5341
5342 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5343 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005344 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005345 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005346 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5347 }
5348
5349 return skip;
5350}
5351
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005352// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005353template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005354bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5355 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005356 VkPipelineStageFlags dst_stage_mask) const {
5357 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005358 assert(cb_state);
5359 auto queue_flags = cb_state->GetQueueFlags();
5360
5361 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005362 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5363 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005364 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005365 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5366 }
5367 return skip;
5368}
5369
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005370// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005371template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005372bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5373 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005374 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005375 assert(cb_state);
5376 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005377
Jeremy Gebbenefead332021-06-18 08:22:44 -06005378 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005379 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005380 skip |=
5381 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5382 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005383
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005384 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005385 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005386 skip |=
5387 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5388 }
5389 return skip;
5390}
5391
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005392// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5393// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5394// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5395static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5396 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5397}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005398
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005399bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5400 const VkSubpassDependency2 &dependency) const {
5401 bool skip = false;
5402 Location loc = in_loc;
5403 VkMemoryBarrier2KHR converted_barrier;
5404 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5405
5406 if (mem_barrier && enabled_features.synchronization2_features.synchronization2) {
5407 if (dependency.srcAccessMask != 0) {
5408 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5409 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5410 loc.dot(Field::srcAccessMask).Message().c_str());
5411 }
5412 if (dependency.dstAccessMask != 0) {
5413 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5414 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5415 loc.dot(Field::dstAccessMask).Message().c_str());
5416 }
5417 if (dependency.srcStageMask != 0) {
5418 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5419 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5420 loc.dot(Field::srcStageMask).Message().c_str());
5421 }
5422 if (dependency.dstStageMask != 0) {
5423 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5424 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5425 loc.dot(Field::dstStageMask).Message().c_str());
5426 }
5427 loc = in_loc.dot(Field::pNext);
5428 converted_barrier = *mem_barrier;
5429 } else {
5430 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005431 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5432 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5433 loc.Message().c_str());
5434 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005435 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5436 converted_barrier.srcStageMask = dependency.srcStageMask;
5437 converted_barrier.dstStageMask = dependency.dstStageMask;
5438 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5439 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005440 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005441 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5442 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5443 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5444 converted_barrier.srcStageMask);
5445
5446 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5447 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5448 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5449 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005450 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005451}
5452
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005453bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5454 const VkImageUsageFlags image_usage) const {
5455 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5456 bool skip = false;
5457
5458 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5459 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5460
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005461 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005462 // AHB image view and image share same feature sets
5463 tiling_features = image_state->format_features;
5464 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5465 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005466 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005467 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5468 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005469 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005470
5471 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5472 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5473 nullptr};
5474 format_properties_2.pNext = (void *)&drm_properties_list;
5475 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5476
nyorain38a9d232021-03-06 13:06:12 +01005477 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5478 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5479 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5480
5481 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5482
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005483 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5484 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5485 0) {
5486 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5487 }
5488 }
5489 } else {
5490 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5491 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5492 : format_properties.optimalTilingFeatures;
5493 }
5494
5495 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005496 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005497 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5498 "physical device.",
5499 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5500 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005501 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005502 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5503 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5504 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5505 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005506 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005507 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5508 "VK_IMAGE_USAGE_STORAGE_BIT.",
5509 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5510 } 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 -06005511 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005512 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5513 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5514 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5515 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5516 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005517 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005518 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5519 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5520 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5521 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5522 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005523 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005524 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5525 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5526 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005527 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5528 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5529 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005530 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005531 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5532 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5533 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5534 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005535 }
5536
5537 return skip;
5538}
5539
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005540bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005541 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005542 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005543 const auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005544 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005545 skip |=
5546 ValidateImageUsageFlags(image_state,
5547 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5548 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005549 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5550 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5551 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005552 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005553 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005554 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005555 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005556 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005557 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005558 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005559 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005560
5561 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5562 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005563 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005564 VkFormat view_format = pCreateInfo->format;
5565 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005566 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005567 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005568 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005569
Dave Houltonbd2e2622018-04-10 16:41:14 -06005570 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005571 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005572 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005573 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5574 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005575 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005576 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5577 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5578 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005579 }
5580 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005581 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005582 if (image_stencil_struct == nullptr) {
5583 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005584 skip |= LogError(
5585 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005586 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5587 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5588 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5589 }
5590 } else {
5591 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5592 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5593 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005594 skip |= LogError(
5595 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005596 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5597 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5598 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5599 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5600 }
5601 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5602 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005603 skip |= LogError(
5604 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005605 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5606 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5607 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5608 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5609 }
5610 }
5611 }
5612 }
5613
Dave Houltonbd2e2622018-04-10 16:41:14 -06005614 image_usage = chained_ivuci_struct->usage;
5615 }
5616
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005617 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5618 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5619 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5620 bool foundFormat = false;
5621 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5622 if (format_list_info->pViewFormats[i] == view_format) {
5623 foundFormat = true;
5624 break;
5625 }
5626 }
5627 if (foundFormat == false) {
5628 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5629 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5630 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5631 string_VkFormat(view_format));
5632 }
5633 }
5634
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005635 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5636 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005637 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005638 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005639 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005640 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005641 std::stringstream ss;
5642 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005643 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005644 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005645 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005646 }
5647 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005648 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005649 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
sfricke-samsung9a65d282021-03-17 23:41:59 -07005650 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5651 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5652 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5653 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005654 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005655 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5656 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005657 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005658 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5659 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005660 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005661 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5662 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005663 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5664 } else {
5665 // both enabled
5666 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5667 }
Dave Houltonc7988072018-04-16 11:46:56 -06005668 std::stringstream ss;
5669 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005670 << " is not in the same format compatibility class as "
5671 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005672 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5673 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005674 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005675 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005676 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005677 }
5678 } else {
5679 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005680 // Unless it is a multi-planar color bit aspect
5681 if ((image_format != view_format) &&
5682 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005683 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5684 ? "VUID-VkImageViewCreateInfo-image-01762"
5685 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005686 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005687 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005688 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005689 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005690 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005691 }
5692 }
5693
ziga-lunargebb32de2021-08-29 21:24:30 +02005694 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5695 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5696 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5697 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5698 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5699 }
5700
Mark Lobodzinski602de982017-02-09 11:01:33 -07005701 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005702 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005703
sfricke-samsung20a8a372021-07-14 06:12:17 -07005704 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005705 switch (image_type) {
5706 case VK_IMAGE_TYPE_1D:
5707 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005708 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5709 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5710 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005711 }
5712 break;
5713 case VK_IMAGE_TYPE_2D:
5714 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5715 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5716 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005717 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5718 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5719 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005720 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005721 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5722 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5723 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005724 }
5725 }
5726 break;
5727 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005728 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005729 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5730 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005731 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005732 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005733 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005734 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5735 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005736 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005737 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5738 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005739 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005740 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005741 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5742 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5743 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5744 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005745 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5746 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5747 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5748 "levelCount of 1 but it is %u.",
5749 string_VkImageViewType(view_type), string_VkImageType(image_type),
5750 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005751 }
5752 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005753 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5754 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5755 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005756 }
5757 }
5758 } else {
5759 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005760 // Help point to VK_KHR_maintenance1
5761 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5762 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5763 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5764 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5765 string_VkImageViewType(view_type), string_VkImageType(image_type));
5766 } else {
5767 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5768 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5769 string_VkImageViewType(view_type), string_VkImageType(image_type));
5770 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005771 }
5772 }
5773 break;
5774 default:
5775 break;
5776 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005777
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005778 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005779 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005780 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005781 }
5782
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005783 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005784
sfricke-samsung828e59d2021-08-22 23:20:49 -07005785 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005786 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5787 if (view_format != VK_FORMAT_R8_UINT) {
5788 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5789 "vkCreateImageView() If image was created with usage containing "
5790 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5791 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005792 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005793 }
5794
sfricke-samsung828e59d2021-08-22 23:20:49 -07005795 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00005796 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5797 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5798 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5799 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5800 "vkCreateImageView() If image was created with usage containing "
5801 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5802 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5803 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005804 }
5805 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005806
Tobias Hector6663c9b2020-11-05 10:18:02 +00005807 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5808 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005809 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005810 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5811 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005812 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005813 }
5814
sfricke-samsung20a8a372021-07-14 06:12:17 -07005815 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5816 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5817 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005818 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5819 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005820 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005821 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005822 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005823 skip |= LogError(
5824 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5825 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005826 remaining_layers);
5827 }
5828 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5829 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5830 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5831 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5832 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5833 string_VkImageViewType(view_type), remaining_layers);
5834 }
5835 } else {
5836 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5837 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5838 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5839 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5840 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5841 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005842 }
5843 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005844
5845 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5846 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005847 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005848 "vkCreateImageView(): If image was created with usage containing "
5849 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5850 pCreateInfo->subresourceRange.levelCount);
5851 }
5852 }
5853 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5854 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005855 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005856 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5857 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5858 }
5859 } else {
5860 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5861 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5862 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005863 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005864 "vkCreateImageView(): If image was created with usage containing "
5865 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5866 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5867 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5868 }
5869 }
5870 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005871
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005872 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5873 if (pCreateInfo->subresourceRange.levelCount != 1) {
5874 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5875 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5876 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5877 pCreateInfo->subresourceRange.levelCount);
5878 }
5879 if (pCreateInfo->subresourceRange.layerCount != 1) {
5880 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5881 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5882 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5883 pCreateInfo->subresourceRange.layerCount);
5884 }
5885 }
5886
Nathaniel Cesario42d5b282021-08-17 12:47:24 -06005887 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(view_format) &&
ziga-lunargc290c7f2021-07-31 22:01:46 +02005888 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5889 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5890 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5891 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5892 string_VkFormat(image_format));
5893 }
5894
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005895 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5896 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5897 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5898 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5899 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5900 }
5901 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5902 skip |=
5903 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5904 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5905 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5906 }
5907 }
sfricke-samsung45996a42021-09-16 13:45:27 -07005908 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005909 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005910 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005911 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5912 "vkCreateImageView(): If image was created with flags containing "
5913 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5914 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005915 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005916 }
5917 }
5918
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005919 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07005920 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005921 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5922 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5923 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5924 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5925 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5926 }
5927 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005928
sfricke-samsung45996a42021-09-16 13:45:27 -07005929 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005930 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005931 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5932 // VK_COMPONENT_SWIZZLE_IDENTITY."
5933 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5934 // also be defined via R, G, B, A enums in the correct order.
5935 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005936 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005937 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005938 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5939 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5940 }
5941
5942 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5943 // disabled
5944 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5945 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5946 // spec. See Github issue #2361.
5947 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5948 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5949 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07005950 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005951 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5952 "vkCreateImageView (portability error): ImageView format must have"
5953 " the same number of components and bits per component as the Image's format");
5954 }
5955 }
Tony-LunarG69604c42021-11-22 16:00:12 -07005956
5957 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
5958 if (image_view_min_lod) {
5959 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
5960 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
5961 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
5962 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
5963 image_view_min_lod->minLod);
5964 }
5965 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
5966 if (image_view_min_lod->minLod > max_level) {
5967 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
5968 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
5969 "accessible to the view (%" PRIu32 ")",
5970 image_view_min_lod->minLod, max_level);
5971 }
5972 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005973 }
5974 return skip;
5975}
5976
Jeff Leger178b1e52020-10-05 12:22:23 -04005977template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005978bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005979 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005980 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005981 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5982 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5983 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005984
5985 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5986 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5987 VkDeviceSize src_min = UINT64_MAX;
5988 VkDeviceSize src_max = 0;
5989 VkDeviceSize dst_min = UINT64_MAX;
5990 VkDeviceSize dst_max = 0;
5991
5992 for (uint32_t i = 0; i < regionCount; i++) {
5993 src_min = std::min(src_min, pRegions[i].srcOffset);
5994 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5995 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5996 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5997
5998 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5999 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006000 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006001 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006002 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6003 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
6004 func_name, i, pRegions[i].srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006005 }
6006
6007 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
6008 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006009 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006010 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006011 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6012 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
6013 func_name, i, pRegions[i].dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006014 }
6015
6016 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6017 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006018 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006019 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006020 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006021 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006022 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006023 }
6024
6025 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6026 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006027 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006028 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006029 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006030 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006031 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006032 }
6033 }
6034
6035 // 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 -06006036 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006037 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006038 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006039 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04006040 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006041 }
6042 }
6043
6044 return skip;
6045}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006046template <typename RegionType>
6047bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
6048 const RegionType *pRegions, CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006049 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6050 const auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6051 const auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006052
sfricke-samsung11813ab2021-10-20 14:53:37 -07006053 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6054 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFER2KHR : CMD_COPYBUFFER;
6055 const char *func_name = CommandTypeString(cmd_type);
6056 const char *vuid;
6057
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006058 bool skip = false;
sfricke-samsung11813ab2021-10-20 14:53:37 -07006059 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
6060 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6061 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
6062 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
6063
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006064 // Validate that SRC & DST buffers have correct usage flags set
sfricke-samsung11813ab2021-10-20 14:53:37 -07006065 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
6066 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
6067 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6068 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
6069 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
6070 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6071
6072 skip |= ValidateCmd(cb_node, cmd_type);
6073 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, version);
6074
6075 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
6076 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6077 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
6078 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6079 vuid = is_2khr ? "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
6080 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006081 return skip;
6082}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006083
sfricke-samsung11813ab2021-10-20 14:53:37 -07006084bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6085 uint32_t regionCount, const VkBufferCopy *pRegions) const {
6086 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, COPY_COMMAND_VERSION_1);
6087}
6088
Jeff Leger178b1e52020-10-05 12:22:23 -04006089bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6090 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006091 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6092 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006093}
6094
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006095bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006096 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006097 auto buffer_state = Get<BUFFER_STATE>(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006098 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006099 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006100 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6101 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006102 }
6103 }
6104 return skip;
6105}
6106
Jeff Bolz5c801d12019-10-09 10:38:45 -05006107bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6108 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006109 const auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006110
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006111 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006112 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006113 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006114 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006115 }
6116 return skip;
6117}
6118
Jeff Bolz5c801d12019-10-09 10:38:45 -05006119bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006120 auto buffer_state = Get<BUFFER_STATE>(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006121
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006122 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006123 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006124 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006125 }
6126 return skip;
6127}
6128
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006129void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6130 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6131 if (buffer_state) {
6132 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
6133 if (itr != buffer_address_map_.end()) {
6134 buffer_address_map_.erase(itr);
6135 }
6136 }
6137 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6138}
6139
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006140bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006141 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006142 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006143 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006144 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006145 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006146 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006147 }
6148 return skip;
6149}
6150
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006151bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006152 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006153 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6154 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006155 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006156 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
sfricke-samsung85584a72021-09-30 21:43:38 -07006157 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006158 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006159 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6160 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006161
sfricke-samsung022fa252020-07-24 03:26:16 -07006162 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6163 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6164
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006165 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006166 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6167 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6168 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6169 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006170 }
6171
6172 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006173 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6174 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6175 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6176 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006177 }
6178
sfricke-samsung45996a42021-09-16 13:45:27 -07006179 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006180 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6181 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6182 }
6183
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006184 return skip;
6185}
6186
Jeff Leger178b1e52020-10-05 12:22:23 -04006187template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006188bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006189 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006190 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006191 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006192 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6193 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006194
sfricke-samsung125d2b42020-05-28 06:32:43 -07006195 assert(image_state != nullptr);
6196 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006197
6198 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006199 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006200 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6201 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006202 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006203 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6204 "and 1, respectively.",
6205 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006206 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006207 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006208
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006209 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6210 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006211 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006212 "%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 -07006213 "must be 0 and 1, respectively.",
6214 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006215 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006216 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006217
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006218 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6219 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006220 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006221 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006222 "For 3D images these must be 0 and 1, respectively.",
6223 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006224 }
6225 }
6226
6227 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006228 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006229 const uint32_t element_size =
6230 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006231 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006232
sfricke-samsung8feecc12021-01-23 03:28:38 -08006233 if (FormatIsDepthOrStencil(image_format)) {
6234 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006235 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006236 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6237 " must be a multiple 4 if using a depth/stencil format (%s).",
6238 function, i, bufferOffset, string_VkFormat(image_format));
6239 }
6240 } else {
6241 // If not depth/stencil and not multi-plane
6242 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006243 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
sfricke-samsung8feecc12021-01-23 03:28:38 -08006244 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6245 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006246 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006247 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6248 " must be a multiple of this format's texel size (%" PRIu32 ").",
6249 function, i, bufferOffset, element_size);
6250 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006251 }
6252
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006253 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6254 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006255 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006256 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006257 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006258 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006259 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006260 }
6261
6262 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6263 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006264 vuid =
6265 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006266 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006267 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006268 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6269 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006270 }
6271
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006272 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006273 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006274 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006275 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 -06006276 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6277 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006278 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006279 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006280 "zero or <= image subresource width (%d).",
6281 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006282 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006283 }
6284
6285 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006286 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 -06006287 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6288 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006289 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006290 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006291 "zero or <= image subresource height (%d).",
6292 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006293 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006294 }
6295
6296 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006297 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 -06006298 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6299 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006300 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006301 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006302 "zero or <= image subresource depth (%d).",
6303 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006304 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006305 }
6306
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006307 // subresource aspectMask must have exactly 1 bit set
6308 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006309 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006310 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006311 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006312 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006313 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006314 }
6315
6316 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006317 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006318 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006319 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006320 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6321 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006322 }
6323
6324 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006325 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006326 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006327
6328 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006329 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006330 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
6331 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
6332 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006333 }
6334
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006335 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006336 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006337 skip |=
6338 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
6339 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
6340 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006341 }
6342
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006343 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006344 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6345 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6346 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006347 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006348 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006349 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006350 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6351 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006352 }
6353
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006354 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006355 if (SafeModulo(bufferOffset, element_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006356 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006357 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006358 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006359 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006360 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006361
6362 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006363 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006364 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006365 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006366 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006367 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006368 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006369 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6370 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006371 }
6372
6373 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006374 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006375 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006376 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006377 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006378 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006379 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6380 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006381 }
6382
6383 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006384 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006385 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006386 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006387 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006388 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006389 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6390 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006391 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006392 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006393
6394 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006395 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006396 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006397 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006398 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006399 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006400 "format has three planes.",
6401 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006402 }
6403
6404 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006405 if (0 ==
6406 (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 -06006407 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006408 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006409 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6410 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006411 } else {
6412 // Know aspect mask is valid
6413 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6414 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006415 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006416 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006417 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006418 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006419 " 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 -08006420 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006421 string_VkFormat(compatible_format));
6422 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006423 }
6424 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006425
6426 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006427 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006428 assert(command_pool != nullptr);
6429 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006430 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006431 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006432 LogObjectList objlist(cb_node->commandBuffer());
6433 objlist.add(command_pool->commandPool());
6434 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006435 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6436 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6437 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6438 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006439 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6440 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006441 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006442 }
6443
6444 return skip;
6445}
6446
Jeff Leger178b1e52020-10-05 12:22:23 -04006447template <typename BufferImageCopyRegionType>
6448bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6449 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006450 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006451 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006452
6453 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006454 VkExtent3D extent = pRegions[i].imageExtent;
6455 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006456
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006457 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6458 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006459 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006460 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6461 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006462 }
6463
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006464 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006465
sfricke-samsung01da6312021-10-20 07:51:32 -07006466 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6467 // vkspec.html#_common_operation)
6468 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006469 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006470 if (image_extent.width % block_extent.width) {
6471 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6472 }
6473 if (image_extent.height % block_extent.height) {
6474 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6475 }
6476 if (image_extent.depth % block_extent.depth) {
6477 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6478 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006479 }
6480
Dave Houltonfc1a4052017-04-27 14:32:45 -06006481 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006482 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006483 }
6484 }
6485
6486 return skip;
6487}
6488
Jeff Leger178b1e52020-10-05 12:22:23 -04006489template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006490bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006491 const BufferImageCopyRegionType *pRegions, const char *func_name,
6492 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006493 bool skip = false;
6494
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006495 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006496
6497 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006498 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format);
6499 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6500 if (buffer_copy_size != 0) {
6501 const VkDeviceSize max_buffer_copy = buffer_copy_size + pRegions[i].bufferOffset;
6502 if (buffer_size < max_buffer_copy) {
6503 skip |= LogError(device, msg_code,
6504 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6505 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
6506 func_name, i, buffer_copy_size, pRegions[i].bufferOffset,
6507 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6508 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006509 }
6510 }
6511
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006512 return skip;
6513}
6514
Jeff Leger178b1e52020-10-05 12:22:23 -04006515template <typename BufferImageCopyRegionType>
6516bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6517 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6518 CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006519 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6520 const auto src_image_state = Get<IMAGE_STATE>(srcImage);
6521 const auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006522
Jeff Leger178b1e52020-10-05 12:22:23 -04006523 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006524 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
sfricke-samsung85584a72021-09-30 21:43:38 -07006525 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006526 const char *vuid;
6527
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006528 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006529
6530 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006531 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006532
6533 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006534 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006535
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006536 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006537
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006538 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006539 vuid =
6540 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6541 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6542 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6543 "or transfer capabilities.",
6544 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006545 }
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006546 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeff Leger178b1e52020-10-05 12:22:23 -04006547 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6548 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6549 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006550
Jeff Leger178b1e52020-10-05 12:22:23 -04006551 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6552 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6553 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6554
6555 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6556 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6557 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6558 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006559
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006560 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006561 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6562 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006563 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006564 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6565 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006566 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006567 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6568 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6569 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6570 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6571 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6572 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006573
6574 // Validation for VK_EXT_fragment_density_map
6575 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006576 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006577 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006578 "%s: srcImage must not have been created with flags containing "
6579 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6580 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006581 }
6582
sfricke-samsung45996a42021-09-16 13:45:27 -07006583 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006584 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6585 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006586 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006587 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006588
sfricke-samsung45996a42021-09-16 13:45:27 -07006589 const char *src_invalid_layout_vuid =
6590 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6591 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6592 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6593 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6594 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006595
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006596 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006597 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6598 vuid =
6599 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006600 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006601 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6602 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6603 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6604 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6605 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6606 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6607 "imageSubresource", vuid);
6608 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6609 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006610 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006611 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006612 }
6613 return skip;
6614}
6615
Jeff Leger178b1e52020-10-05 12:22:23 -04006616bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6617 VkBuffer dstBuffer, uint32_t regionCount,
6618 const VkBufferImageCopy *pRegions) const {
6619 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6620 COPY_COMMAND_VERSION_1);
6621}
6622
6623bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6624 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6625 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6626 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6627 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6628}
6629
John Zulauf1686f232019-07-09 16:27:11 -06006630void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6631 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6632 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6633
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006634 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6635 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006636 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006637 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006638 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006639 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006640}
6641
Jeff Leger178b1e52020-10-05 12:22:23 -04006642void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6643 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6644 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6645
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006646 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6647 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006648 // Make sure that all image slices record referenced layout
6649 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006650 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6651 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006652 }
6653}
6654
6655template <typename RegionType>
6656bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6657 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6658 CopyCommandVersion version) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006659 const auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6660 const auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6661 const auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006662
Jeff Leger178b1e52020-10-05 12:22:23 -04006663 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006664 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07006665 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006666 const char *vuid;
6667
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006668 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006669
6670 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006671 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006672
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006673 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeff Leger178b1e52020-10-05 12:22:23 -04006674 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6675 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6676 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6677
6678 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6679 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6680 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6681 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6682 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6683 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6684 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6685 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6686 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006687 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006688 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6689 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006690 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006691 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6692 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6693 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6694 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6695 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6696 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006697
6698 // Validation for VK_EXT_fragment_density_map
6699 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006700 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006701 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006702 "%s: dstImage must not have been created with flags containing "
6703 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6704 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006705 }
6706
sfricke-samsung45996a42021-09-16 13:45:27 -07006707 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006708 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6709 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006710 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006711 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006712
sfricke-samsung45996a42021-09-16 13:45:27 -07006713 const char *dst_invalid_layout_vuid =
6714 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6715 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6716 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6717 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6718 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006719
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006720 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006721 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6722 vuid =
6723 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006724 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006725 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6726 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6727 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6728 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6729 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6730 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6731 "imageSubresource", vuid);
6732 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6733 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006734 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006735 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006736
6737 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006738 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07006739 assert(command_pool != nullptr);
6740 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006741 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsungea4fd142020-10-17 23:51:59 -07006742 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6743 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6744 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006745 LogObjectList objlist(cb_node->commandBuffer());
6746 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006747 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6748 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006749 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006750 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6751 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6752 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006753 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6754 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006755 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006756 }
6757 return skip;
6758}
6759
Jeff Leger178b1e52020-10-05 12:22:23 -04006760bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6761 VkImageLayout dstImageLayout, uint32_t regionCount,
6762 const VkBufferImageCopy *pRegions) const {
6763 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6764 COPY_COMMAND_VERSION_1);
6765}
6766
6767bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6768 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6769 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6770 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6771 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6772}
6773
John Zulauf1686f232019-07-09 16:27:11 -06006774void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6775 VkImageLayout dstImageLayout, uint32_t regionCount,
6776 const VkBufferImageCopy *pRegions) {
6777 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6778
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006779 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6780 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006781 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006782 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006783 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006784 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006785}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006786
Jeff Leger178b1e52020-10-05 12:22:23 -04006787void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6788 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6789 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6790
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006791 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6792 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006793 // Make sure that all image slices are record referenced layout
6794 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006795 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6796 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006797 }
6798}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006799bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006800 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006801 bool skip = false;
6802 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6803
Dave Houlton1d960ff2018-01-19 12:17:05 -07006804 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006805 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6806 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6807 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006808 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6809 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006810 }
6811
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006812 const auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006813 if (!image_entry) {
6814 return skip;
6815 }
6816
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006817 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07006818 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006819 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6820 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006821 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6822 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6823 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006824 }
6825 } else {
6826 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006827 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6828 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006829 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006830 }
6831
Dave Houlton1d960ff2018-01-19 12:17:05 -07006832 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006833 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006834 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6835 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6836 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006837 }
6838
Dave Houlton1d960ff2018-01-19 12:17:05 -07006839 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006840 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006841 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6842 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6843 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006844 }
6845
Dave Houlton1d960ff2018-01-19 12:17:05 -07006846 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006847 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006848 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6849 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006850 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006851 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6852 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006853 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006854 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6855 }
6856 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006857 skip |= LogError(image, vuid,
6858 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6859 ") must be a single-plane specifier flag.",
6860 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006861 }
6862 } else if (FormatIsColor(img_format)) {
6863 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02006864 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006865 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6866 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006867 }
6868 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006869 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006870 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006871 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02006872 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
6873 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
6874 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6875 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
6876 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
6877 string_VkFormat(img_format));
6878 }
6879 } else {
6880 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
6881 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
6882 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
6883 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
6884 string_VkFormat(img_format));
6885 }
6886 }
6887 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
6888 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
6889 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6890 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
6891 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
6892 string_VkFormat(img_format));
6893 }
6894 } else {
6895 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
6896 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
6897 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
6898 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
6899 string_VkFormat(img_format));
6900 }
6901 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006902 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6903 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6904 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6905 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006906 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6907 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6908 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006909 }
6910 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006911
sfricke-samsung45996a42021-09-16 13:45:27 -07006912 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006913 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006914 }
6915
Mike Weiblen672b58b2017-02-21 14:32:53 -07006916 return skip;
6917}
sfricke-samsung022fa252020-07-24 03:26:16 -07006918
6919// Validates the image is allowed to be protected
6920bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006921 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006922 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006923
6924 // if driver supports protectedNoFault the operation is valid, just has undefined values
6925 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006926 LogObjectList objlist(cb_state->commandBuffer());
6927 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006928 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 -06006929 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6930 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006931 }
6932 return skip;
6933}
6934
6935// Validates the image is allowed to be unprotected
6936bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006937 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006938 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006939
6940 // if driver supports protectedNoFault the operation is valid, just has undefined values
6941 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006942 LogObjectList objlist(cb_state->commandBuffer());
6943 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006944 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 -06006945 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6946 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006947 }
6948 return skip;
6949}
6950
6951// Validates the buffer is allowed to be protected
6952bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006953 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006954 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006955
6956 // if driver supports protectedNoFault the operation is valid, just has undefined values
6957 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006958 LogObjectList objlist(cb_state->commandBuffer());
6959 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006960 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 -06006961 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6962 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006963 }
6964 return skip;
6965}
6966
6967// Validates the buffer is allowed to be unprotected
6968bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006969 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006970 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08006971
6972 // if driver supports protectedNoFault the operation is valid, just has undefined values
6973 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006974 LogObjectList objlist(cb_state->commandBuffer());
6975 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006976 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 -06006977 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6978 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006979 }
6980 return skip;
6981}